View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.numbers.complex;
18  
19  import org.junit.jupiter.api.Assertions;
20  import org.junit.jupiter.api.Test;
21  
22  /**
23   * Tests for examples contained in the user guide.
24   */
25  class UserGuideTest {
26  
27      @Test
28      void testComplex1() {
29          double x = 3;
30          double y = 4;
31          Complex c1 = Complex.ofCartesian(x, y);
32          // c1 == x + iy
33  
34          double rho = 1.23;
35          double theta = Math.PI / 2;
36          Complex c2 = Complex.ofPolar(rho, theta);
37  
38          // This is a compilation test. Objects must be valid.
39          Assertions.assertNotNull(c1);
40          Assertions.assertNotNull(c2);
41      }
42  
43      @Test
44      void testComplex2() {
45          Complex c1 = Complex.ofCartesian(3, 4);
46          Complex c2 = Complex.ofCartesian(5, 6);
47          Complex c3 = c1.multiply(c2).sqrt();
48  
49          double magnitude = c3.abs();
50          double argument = c3.arg();
51  
52          boolean finite = c3.isFinite();
53  
54          // This is a compilation test. Objects must be valid.
55          Assertions.assertTrue(Double.isFinite(magnitude));
56          Assertions.assertTrue(Double.isFinite(argument));
57          Assertions.assertTrue(finite);
58      }
59  }