Tuple (Hipparchus 1.3 API)

java.lang.Object
- org.hipparchus.util.Tuple

All Implemented Interfaces:

FieldElement<Tuple>, RealFieldElement<Tuple>
```
public class Tuple
extends Object
implements RealFieldElement<Tuple>
```
This class allows to perform the same computation of all components of a Tuple at once.

Since:

1.2

Constructor Summary

Constructors
Constructor Description

Tuple(double... x)
Creates a new instance from its components.

Constructors
Constructor	Description
`Tuple(double... x)`	Creates a new instance from its components.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Tuple`	`abs()`	absolute value.
`Tuple`	`acos()`	Arc cosine operation.
`Tuple`	`acosh()`	Inverse hyperbolic cosine operation.
`Tuple`	`add(double a)`	'+' operator.
`Tuple`	`add(Tuple a)`	Compute this + a.
`Tuple`	`asin()`	Arc sine operation.
`Tuple`	`asinh()`	Inverse hyperbolic sine operation.
`Tuple`	`atan()`	Arc tangent operation.
`Tuple`	`atan2(Tuple x)`	Two arguments arc tangent operation.
`Tuple`	`atanh()`	Inverse hyperbolic tangent operation.
`Tuple`	`cbrt()`	Cubic root.
`Tuple`	`ceil()`	Get the smallest whole number larger than instance.
`Tuple`	`copySign(double sign)`	Returns the instance with the sign of the argument.
`Tuple`	`copySign(Tuple sign)`	Returns the instance with the sign of the argument.
`Tuple`	`cos()`	Cosine operation.
`Tuple`	`cosh()`	Hyperbolic cosine operation.
`Tuple`	`divide(double a)`	'÷' operator.
`Tuple`	`divide(Tuple a)`	Compute this ÷ a.
`boolean`	`equals(Object obj)`
`Tuple`	`exp()`	Exponential.
`Tuple`	`expm1()`	Exponential minus 1.
`Tuple`	`floor()`	Get the largest whole number smaller than instance.
`double`	`getComponent(int index)`	Get one component of the tuple.
`double[]`	`getComponents()`	Get all components of the tuple.
`int`	`getDimension()`	Get the dimension of the tuple.
`Field<Tuple>`	`getField()`	Get the `Field` to which the instance belongs.
`double`	`getReal()`	Get the real value of the number.
`int`	`hashCode()`
`Tuple`	`hypot(Tuple y)`	Returns the hypotenuse of a triangle with sides `this` and `y` - sqrt(this² +y²) avoiding intermediate overflow or underflow.
`Tuple`	`linearCombination(double[] a, Tuple[] b)`	Compute a linear combination.
`Tuple`	`linearCombination(double a1, Tuple b1, double a2, Tuple b2)`	Compute a linear combination.
`Tuple`	`linearCombination(double a1, Tuple b1, double a2, Tuple b2, double a3, Tuple b3)`	Compute a linear combination.
`Tuple`	`linearCombination(double a1, Tuple b1, double a2, Tuple b2, double a3, Tuple b3, double a4, Tuple b4)`	Compute a linear combination.
`Tuple`	`linearCombination(Tuple[] a, Tuple[] b)`	Compute a linear combination.
`Tuple`	`linearCombination(Tuple a1, Tuple b1, Tuple a2, Tuple b2)`	Compute a linear combination.
`Tuple`	`linearCombination(Tuple a1, Tuple b1, Tuple a2, Tuple b2, Tuple a3, Tuple b3)`	Compute a linear combination.
`Tuple`	`linearCombination(Tuple a1, Tuple b1, Tuple a2, Tuple b2, Tuple a3, Tuple b3, Tuple a4, Tuple b4)`	Compute a linear combination.
`Tuple`	`log()`	Natural logarithm.
`Tuple`	`log10()`	Base 10 logarithm.
`Tuple`	`log1p()`	Shifted natural logarithm.
`Tuple`	`multiply(double a)`	'×' operator.
`Tuple`	`multiply(int n)`	Compute n × this.
`Tuple`	`multiply(Tuple a)`	Compute this × a.
`Tuple`	`negate()`	Returns the additive inverse of `this` element.
`Tuple`	`pow(double p)`	Power operation.
`Tuple`	`pow(int n)`	Integer power operation.
`Tuple`	`pow(Tuple e)`	Power operation.
`Tuple`	`reciprocal()`	Returns the multiplicative inverse of `this` element.
`Tuple`	`remainder(double a)`	IEEE remainder operator.
`Tuple`	`remainder(Tuple a)`	IEEE remainder operator.
`Tuple`	`rint()`	Get the whole number that is the nearest to the instance, or the even one if x is exactly half way between two integers.
`Tuple`	`rootN(int n)`	N^th root.
`long`	`round()`	Get the closest long to instance value.
`Tuple`	`scalb(int n)`	Multiply the instance by a power of 2.
`Tuple`	`signum()`	Compute the signum of the instance.
`Tuple`	`sin()`	Sine operation.
`Tuple`	`sinh()`	Hyperbolic sine operation.
`Tuple`	`sqrt()`	Square root.
`Tuple`	`subtract(double a)`	'-' operator.
`Tuple`	`subtract(Tuple a)`	Compute this - a.
`Tuple`	`tan()`	Tangent operation.
`Tuple`	`tanh()`	Hyperbolic tangent operation.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Tuple
```
public Tuple(double... x)
```
    Creates a new instance from its components.
    
    Parameters:
    
    x - components of the tuple
- Method Detail
  - getDimension
```
public int getDimension()
```
    Get the dimension of the tuple.
    
    Returns:
    
    dimension of the tuple
  - getComponent
```
public double getComponent(int index)
```
    Get one component of the tuple.
    
    Parameters:
    
    index - index of the component, between 0 and getDimension() - 1
    
    Returns:
    
    value of the component
  - getComponents
```
public double[] getComponents()
```
    Get all components of the tuple.
    
    Returns:
    
    all components
  - getField
```
public Field<Tuple> getField()
```
    Get the Field to which the instance belongs.
    
    Specified by:
    
    getField in interface FieldElement<Tuple>
    
    Returns:
    
    Field to which the instance belongs
  - add
```
public Tuple add(Tuple a)
```
    Compute this + a.
    
    Specified by:
    
    add in interface FieldElement<Tuple>
    
    Parameters:
    
    a - element to add
    
    Returns:
    
    a new element representing this + a
  - subtract
```
public Tuple subtract(Tuple a)
```
    Compute this - a.
    
    Specified by:
    
    subtract in interface FieldElement<Tuple>
    
    Parameters:
    
    a - element to subtract
    
    Returns:
    
    a new element representing this - a
  - negate
```
public Tuple negate()
```
    Returns the additive inverse of this element.
    
    Specified by:
    
    negate in interface FieldElement<Tuple>
    
    Returns:
    
    the opposite of this.
  - multiply
```
public Tuple multiply(Tuple a)
```
    Compute this × a.
    
    Specified by:
    
    multiply in interface FieldElement<Tuple>
    
    Parameters:
    
    a - element to multiply
    
    Returns:
    
    a new element representing this × a
  - multiply
```
public Tuple multiply(int n)
```
    Compute n × this. Multiplication by an integer number is defined as the following sum n × this = ∑_i=1ⁿ this.
    
    Specified by:
    
    multiply in interface FieldElement<Tuple>
    
    Parameters:
    
    n - Number of times this must be added to itself.
    
    Returns:
    
    A new element representing n × this.
  - divide
```
public Tuple divide(Tuple a)
```
    Compute this ÷ a.
    
    Specified by:
    
    divide in interface FieldElement<Tuple>
    
    Parameters:
    
    a - element to divide by
    
    Returns:
    
    a new element representing this ÷ a
  - reciprocal
```
public Tuple reciprocal()
```
    Returns the multiplicative inverse of this element.
    
    Specified by:
    
    reciprocal in interface FieldElement<Tuple>
    
    Specified by:
    
    reciprocal in interface RealFieldElement<Tuple>
    
    Returns:
    
    the inverse of this.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getReal
```
public double getReal()
```
    Get the real value of the number.
    
    Specified by:
    
    getReal in interface RealFieldElement<Tuple>
    
    Returns:
    
    real value
  - add
```
public Tuple add(double a)
```
    '+' operator.
    
    Specified by:
    
    add in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a - right hand side parameter of the operator
    
    Returns:
    
    this+a
  - subtract
```
public Tuple subtract(double a)
```
    '-' operator.
    
    Specified by:
    
    subtract in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a - right hand side parameter of the operator
    
    Returns:
    
    this-a
  - multiply
```
public Tuple multiply(double a)
```
    '×' operator.
    
    Specified by:
    
    multiply in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a - right hand side parameter of the operator
    
    Returns:
    
    this×a
  - divide
```
public Tuple divide(double a)
```
    '÷' operator.
    
    Specified by:
    
    divide in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a - right hand side parameter of the operator
    
    Returns:
    
    this÷a
  - remainder
```
public Tuple remainder(double a)
```
    IEEE remainder operator.
    
    Specified by:
    
    remainder in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a - right hand side parameter of the operator
    
    Returns:
    
    this - n × a where n is the closest integer to this/a (the even integer is chosen for n if this/a is halfway between two integers)
  - remainder
```
public Tuple remainder(Tuple a)
```
    IEEE remainder operator.
    
    Specified by:
    
    remainder in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a - right hand side parameter of the operator
    
    Returns:
    
    this - n × a where n is the closest integer to this/a (the even integer is chosen for n if this/a is halfway between two integers)
  - abs
```
public Tuple abs()
```
    absolute value.
    
    Specified by:
    
    abs in interface RealFieldElement<Tuple>
    
    Returns:
    
    abs(this)
  - ceil
```
public Tuple ceil()
```
    Get the smallest whole number larger than instance.
    
    Specified by:
    
    ceil in interface RealFieldElement<Tuple>
    
    Returns:
    
    ceil(this)
  - floor
```
public Tuple floor()
```
    Get the largest whole number smaller than instance.
    
    Specified by:
    
    floor in interface RealFieldElement<Tuple>
    
    Returns:
    
    floor(this)
  - rint
```
public Tuple rint()
```
    Get the whole number that is the nearest to the instance, or the even one if x is exactly half way between two integers.
    
    Specified by:
    
    rint in interface RealFieldElement<Tuple>
    
    Returns:
    
    a double number r such that r is an integer r - 0.5 ≤ this ≤ r + 0.5
  - round
```
public long round()
```
    Get the closest long to instance value.
    
    Specified by:
    
    round in interface RealFieldElement<Tuple>
    
    Returns:
    
    closest long to RealFieldElement.getReal()
  - signum
```
public Tuple signum()
```
    Compute the signum of the instance. The signum is -1 for negative numbers, +1 for positive numbers and 0 otherwise
    
    Specified by:
    
    signum in interface RealFieldElement<Tuple>
    
    Returns:
    
    -1.0, -0.0, +0.0, +1.0 or NaN depending on sign of a
  - copySign
```
public Tuple copySign(Tuple sign)
```
    Returns the instance with the sign of the argument. A NaN sign argument is treated as positive.
    
    Specified by:
    
    copySign in interface RealFieldElement<Tuple>
    
    Parameters:
    
    sign - the sign for the returned value
    
    Returns:
    
    the instance with the same sign as the sign argument
  - copySign
```
public Tuple copySign(double sign)
```
    Returns the instance with the sign of the argument. A NaN sign argument is treated as positive.
    
    Specified by:
    
    copySign in interface RealFieldElement<Tuple>
    
    Parameters:
    
    sign - the sign for the returned value
    
    Returns:
    
    the instance with the same sign as the sign argument
  - scalb
```
public Tuple scalb(int n)
```
    Multiply the instance by a power of 2.
    
    Specified by:
    
    scalb in interface RealFieldElement<Tuple>
    
    Parameters:
    
    n - power of 2
    
    Returns:
    
    this × 2ⁿ
  - hypot
```
public Tuple hypot(Tuple y)
```
    Returns the hypotenuse of a triangle with sides this and y - sqrt(this² +y²) avoiding intermediate overflow or underflow.
    - If either argument is infinite, then the result is positive infinity.
    - else, if either argument is NaN then the result is NaN.
    Specified by:
    
    hypot in interface RealFieldElement<Tuple>
    
    Parameters:
    
    y - a value
    
    Returns:
    
    sqrt(this² +y²)
  - sqrt
```
public Tuple sqrt()
```
    Square root.
    
    Specified by:
    
    sqrt in interface RealFieldElement<Tuple>
    
    Returns:
    
    square root of the instance
  - cbrt
```
public Tuple cbrt()
```
    Cubic root.
    
    Specified by:
    
    cbrt in interface RealFieldElement<Tuple>
    
    Returns:
    
    cubic root of the instance
  - rootN
```
public Tuple rootN(int n)
```
    N^th root.
    
    Specified by:
    
    rootN in interface RealFieldElement<Tuple>
    
    Parameters:
    
    n - order of the root
    
    Returns:
    
    n^th root of the instance
  - pow
```
public Tuple pow(double p)
```
    Power operation.
    
    Specified by:
    
    pow in interface RealFieldElement<Tuple>
    
    Parameters:
    
    p - power to apply
    
    Returns:
    
    this^p
  - pow
```
public Tuple pow(int n)
```
    Integer power operation.
    
    Specified by:
    
    pow in interface RealFieldElement<Tuple>
    
    Parameters:
    
    n - power to apply
    
    Returns:
    
    thisⁿ
  - pow
```
public Tuple pow(Tuple e)
```
    Power operation.
    
    Specified by:
    
    pow in interface RealFieldElement<Tuple>
    
    Parameters:
    
    e - exponent
    
    Returns:
    
    this^e
  - exp
```
public Tuple exp()
```
    Exponential.
    
    Specified by:
    
    exp in interface RealFieldElement<Tuple>
    
    Returns:
    
    exponential of the instance
  - expm1
```
public Tuple expm1()
```
    Exponential minus 1.
    
    Specified by:
    
    expm1 in interface RealFieldElement<Tuple>
    
    Returns:
    
    exponential minus one of the instance
  - log
```
public Tuple log()
```
    Natural logarithm.
    
    Specified by:
    
    log in interface RealFieldElement<Tuple>
    
    Returns:
    
    logarithm of the instance
  - log1p
```
public Tuple log1p()
```
    Shifted natural logarithm.
    
    Specified by:
    
    log1p in interface RealFieldElement<Tuple>
    
    Returns:
    
    logarithm of one plus the instance
  - log10
```
public Tuple log10()
```
    Base 10 logarithm.
    
    Specified by:
    
    log10 in interface RealFieldElement<Tuple>
    
    Returns:
    
    base 10 logarithm of the instance
  - cos
```
public Tuple cos()
```
    Cosine operation.
    
    Specified by:
    
    cos in interface RealFieldElement<Tuple>
    
    Returns:
    
    cos(this)
  - sin
```
public Tuple sin()
```
    Sine operation.
    
    Specified by:
    
    sin in interface RealFieldElement<Tuple>
    
    Returns:
    
    sin(this)
  - tan
```
public Tuple tan()
```
    Tangent operation.
    
    Specified by:
    
    tan in interface RealFieldElement<Tuple>
    
    Returns:
    
    tan(this)
  - acos
```
public Tuple acos()
```
    Arc cosine operation.
    
    Specified by:
    
    acos in interface RealFieldElement<Tuple>
    
    Returns:
    
    acos(this)
  - asin
```
public Tuple asin()
```
    Arc sine operation.
    
    Specified by:
    
    asin in interface RealFieldElement<Tuple>
    
    Returns:
    
    asin(this)
  - atan
```
public Tuple atan()
```
    Arc tangent operation.
    
    Specified by:
    
    atan in interface RealFieldElement<Tuple>
    
    Returns:
    
    atan(this)
  - atan2
```
public Tuple atan2(Tuple x)
```
    Two arguments arc tangent operation.
    
    Specified by:
    
    atan2 in interface RealFieldElement<Tuple>
    
    Parameters:
    
    x - second argument of the arc tangent
    
    Returns:
    
    atan2(this, x)
  - cosh
```
public Tuple cosh()
```
    Hyperbolic cosine operation.
    
    Specified by:
    
    cosh in interface RealFieldElement<Tuple>
    
    Returns:
    
    cosh(this)
  - sinh
```
public Tuple sinh()
```
    Hyperbolic sine operation.
    
    Specified by:
    
    sinh in interface RealFieldElement<Tuple>
    
    Returns:
    
    sinh(this)
  - tanh
```
public Tuple tanh()
```
    Hyperbolic tangent operation.
    
    Specified by:
    
    tanh in interface RealFieldElement<Tuple>
    
    Returns:
    
    tanh(this)
  - acosh
```
public Tuple acosh()
```
    Inverse hyperbolic cosine operation.
    
    Specified by:
    
    acosh in interface RealFieldElement<Tuple>
    
    Returns:
    
    acosh(this)
  - asinh
```
public Tuple asinh()
```
    Inverse hyperbolic sine operation.
    
    Specified by:
    
    asinh in interface RealFieldElement<Tuple>
    
    Returns:
    
    asin(this)
  - atanh
```
public Tuple atanh()
```
    Inverse hyperbolic tangent operation.
    
    Specified by:
    
    atanh in interface RealFieldElement<Tuple>
    
    Returns:
    
    atanh(this)
  - linearCombination
```
public Tuple linearCombination(Tuple[] a,
                               Tuple[] b)
                        throws MathIllegalArgumentException
```
    Compute a linear combination.
    
    Specified by:
    
    linearCombination in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a - Factors.
    
    b - Factors.
    
    Returns:
    
    Σ_i a_i b_i.
    
    Throws:
    
    MathIllegalArgumentException - if arrays dimensions don't match
  - linearCombination
```
public Tuple linearCombination(double[] a,
                               Tuple[] b)
                        throws MathIllegalArgumentException
```
    Compute a linear combination.
    
    Specified by:
    
    linearCombination in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a - Factors.
    
    b - Factors.
    
    Returns:
    
    Σ_i a_i b_i.
    
    Throws:
    
    MathIllegalArgumentException - if arrays dimensions don't match
  - linearCombination
```
public Tuple linearCombination(Tuple a1,
                               Tuple b1,
                               Tuple a2,
                               Tuple b2)
```
    Compute a linear combination.
    
    Specified by:
    
    linearCombination in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a1 - first factor of the first term
    
    b1 - second factor of the first term
    
    a2 - first factor of the second term
    
    b2 - second factor of the second term
    
    Returns:
    
    a₁×b₁ + a₂×b₂
    
    See Also:
    
    RealFieldElement.linearCombination(Object, Object, Object, Object, Object, Object), RealFieldElement.linearCombination(Object, Object, Object, Object, Object, Object, Object, Object)
  - linearCombination
```
public Tuple linearCombination(double a1,
                               Tuple b1,
                               double a2,
                               Tuple b2)
```
    Compute a linear combination.
    
    Specified by:
    
    linearCombination in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a1 - first factor of the first term
    
    b1 - second factor of the first term
    
    a2 - first factor of the second term
    
    b2 - second factor of the second term
    
    Returns:
    
    a₁×b₁ + a₂×b₂
    
    See Also:
    
    RealFieldElement.linearCombination(double, Object, double, Object, double, Object), RealFieldElement.linearCombination(double, Object, double, Object, double, Object, double, Object)
  - linearCombination
```
public Tuple linearCombination(Tuple a1,
                               Tuple b1,
                               Tuple a2,
                               Tuple b2,
                               Tuple a3,
                               Tuple b3)
```
    Compute a linear combination.
    
    Specified by:
    
    linearCombination in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a1 - first factor of the first term
    
    b1 - second factor of the first term
    
    a2 - first factor of the second term
    
    b2 - second factor of the second term
    
    a3 - first factor of the third term
    
    b3 - second factor of the third term
    
    Returns:
    
    a₁×b₁ + a₂×b₂ + a₃×b₃
    
    See Also:
    
    RealFieldElement.linearCombination(Object, Object, Object, Object), RealFieldElement.linearCombination(Object, Object, Object, Object, Object, Object, Object, Object)
  - linearCombination
```
public Tuple linearCombination(double a1,
                               Tuple b1,
                               double a2,
                               Tuple b2,
                               double a3,
                               Tuple b3)
```
    Compute a linear combination.
    
    Specified by:
    
    linearCombination in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a1 - first factor of the first term
    
    b1 - second factor of the first term
    
    a2 - first factor of the second term
    
    b2 - second factor of the second term
    
    a3 - first factor of the third term
    
    b3 - second factor of the third term
    
    Returns:
    
    a₁×b₁ + a₂×b₂ + a₃×b₃
    
    See Also:
    
    RealFieldElement.linearCombination(double, Object, double, Object), RealFieldElement.linearCombination(double, Object, double, Object, double, Object, double, Object)
  - linearCombination
```
public Tuple linearCombination(Tuple a1,
                               Tuple b1,
                               Tuple a2,
                               Tuple b2,
                               Tuple a3,
                               Tuple b3,
                               Tuple a4,
                               Tuple b4)
```
    Compute a linear combination.
    
    Specified by:
    
    linearCombination in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a1 - first factor of the first term
    
    b1 - second factor of the first term
    
    a2 - first factor of the second term
    
    b2 - second factor of the second term
    
    a3 - first factor of the third term
    
    b3 - second factor of the third term
    
    a4 - first factor of the fourth term
    
    b4 - second factor of the fourth term
    
    Returns:
    
    a₁×b₁ + a₂×b₂ + a₃×b₃ + a₄×b₄
    
    See Also:
    
    RealFieldElement.linearCombination(Object, Object, Object, Object), RealFieldElement.linearCombination(Object, Object, Object, Object, Object, Object)
  - linearCombination
```
public Tuple linearCombination(double a1,
                               Tuple b1,
                               double a2,
                               Tuple b2,
                               double a3,
                               Tuple b3,
                               double a4,
                               Tuple b4)
```
    Compute a linear combination.
    
    Specified by:
    
    linearCombination in interface RealFieldElement<Tuple>
    
    Parameters:
    
    a1 - first factor of the first term
    
    b1 - second factor of the first term
    
    a2 - first factor of the second term
    
    b2 - second factor of the second term
    
    a3 - first factor of the third term
    
    b3 - second factor of the third term
    
    a4 - first factor of the fourth term
    
    b4 - second factor of the fourth term
    
    Returns:
    
    a₁×b₁ + a₂×b₂ + a₃×b₃ + a₄×b₄
    
    See Also:
    
    RealFieldElement.linearCombination(double, Object, double, Object), RealFieldElement.linearCombination(double, Object, double, Object, double, Object)

Class Tuple

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Tuple

Method Detail

getDimension

getComponent

getComponents

getField

add

subtract

negate

multiply

multiply

divide

reciprocal

equals

hashCode

getReal

add

subtract

multiply

divide

remainder

remainder

abs

ceil

floor

rint

round

signum

copySign

copySign

scalb

hypot

sqrt

cbrt

rootN

pow

pow

pow

exp

expm1

log

log1p

log10

cos

sin

tan

acos

asin

atan

atan2

cosh

sinh

tanh

acosh

asinh

atanh

linearCombination

linearCombination

linearCombination

linearCombination

linearCombination

linearCombination

linearCombination

linearCombination