1 /*
2 * Licensed to the Hipparchus project 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 Hipparchus project 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 * https://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.hipparchus.util;
18
19 import org.hipparchus.CalculusFieldElement;
20
21 /** Holder for both sine and cosine values.
22 * <p>
23 * This class is a simple container, it does not provide any computational method.
24 * </p>
25 * @see FastMath#sinCos(org.hipparchus.CalculusFieldElement)
26 * @param <T> the type of the field elements
27 * @since 1.4
28 */
29 public class FieldSinCos<T> {
30
31 /** Value of the sine. */
32 private final T sin;
33
34 /** Value of the cosine. */
35 private final T cos;
36
37 /** Simple constructor.
38 * @param sin value of the sine
39 * @param cos value of the cosine
40 */
41 public FieldSinCos(final T sin, final T cos) {
42 this.sin = sin;
43 this.cos = cos;
44 }
45
46 /** Get the value of the sine.
47 * @return value of the sine
48 */
49 public T sin() {
50 return sin;
51 }
52
53 /** Get the value of the cosine.
54 * @return value of the cosine
55 */
56 public T cos() {
57 return cos;
58 }
59
60 /** Compute sine and cosine of angles sum.
61 * @param scAlpha \((\sin \alpha, \cos \alpha)\)
62 * @param scBeta \((\sin \beta, \cos \beta)\)
63 * @param <S> the type of the field elements
64 * @return \((\sin \alpha+\beta, \cos \alpha+\beta)\)
65 * @since 1.8
66 */
67 public static <S extends CalculusFieldElement<S>> FieldSinCos<S> sum(final FieldSinCos<S> scAlpha, final FieldSinCos<S> scBeta) {
68 return new FieldSinCos<>(scAlpha.sin.linearCombination(scAlpha.sin, scBeta.cos, scAlpha.cos, scBeta.sin),
69 scAlpha.sin.linearCombination(scAlpha.cos, scBeta.cos, scAlpha.sin.negate(), scBeta.sin));
70 }
71
72 /** Compute sine and cosine of angles difference.
73 * @param scAlpha \((\sin \alpha, \cos \alpha)\)
74 * @param scBeta \((\sin \beta, \cos \beta)\)
75 * @param <S> the type of the field elements
76 * @return \((\sin \alpha+\beta, \cos \alpha-\beta)\)
77 * @since 1.8
78 */
79 public static <S extends CalculusFieldElement<S>> FieldSinCos<S> difference(final FieldSinCos<S> scAlpha, final FieldSinCos<S> scBeta) {
80 return new FieldSinCos<>(scAlpha.sin.linearCombination(scAlpha.sin, scBeta.cos, scAlpha.cos.negate(), scBeta.sin),
81 scAlpha.sin.linearCombination(scAlpha.cos, scBeta.cos, scAlpha.sin, scBeta.sin));
82 }
83
84 }