Transform1S (Apache Commons Geometry Spherical 1.0 API)

java.lang.Object
- org.apache.commons.geometry.spherical.oned.Transform1S

All Implemented Interfaces:

Function<Point1S,Point1S>, UnaryOperator<Point1S>, Transform<Point1S>
```
public final class Transform1S
extends Object
implements Transform<Point1S>
```
Implementation of the Transform interface for spherical 1D points.
Similar to the Euclidean 1D AffineTransformMatrix1D, this class performs transformations using an internal 1D affine transformation matrix. In the Euclidean case, the matrix contains a scale factor and a translation. Here, the matrix contains a scale/negation factor that takes the values -1 or +1, and a rotation value. This restriction on the allowed values in the matrix is required in order to fulfill the geometric requirements of the Transform interface. For example, if arbitrary scaling is allowed, the point 0.5pi could be scaled by 4 to 2pi, which is equivalent to 0pi. However, if the inverse scaling of 1/4 is applied to 0pi, the result is 0pi and not 0.5pi. This breaks the Transform requirement that transforms be inversible.

Instances of this class are guaranteed to be immutable.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Point1S`	`apply(Point1S pt)`
`static Transform1S`	`createNegation()` Return a transform instance that negates azimuth values.
`static Transform1S`	`createRotation(double angle)` Return a transform instance that performs a rotation with the given angle.
`boolean`	`equals(Object obj)` Return true if the given object is an instance of `Transform1S` and all transform element values are exactly equal.
`double`	`getRotation()` Get the rotation value applied by this instance, in radians.
`int`	`hashCode()`
`static Transform1S`	`identity()` Return a transform instance representing the identity transform.
`Transform1S`	`inverse()`
`boolean`	`isNegation()` Return true if the transform negates the azimuth values of transformed points, regardless of any rotation applied subsequently.
`Transform1S`	`multiply(Transform1S other)` Multiply the underlying matrix of this instance by that of the argument, eg, `other * this`.
`Transform1S`	`negate()` Return a new transform created by pre-multiplying this instance by a transform that negates azimuth values.
`Transform1S`	`premultiply(Transform1S other)` Multiply the underlying matrix of the argument by that of this instance, eg, `this * other`.
`boolean`	`preservesOrientation()`
`Transform1S`	`rotate(double angle)` Return a new transform created by pre-multiplying this instance by a transform producing a rotation with the given angle.
`String`	`toString()`

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

Methods inherited from interface java.util.function.Function
andThen, compose

- Method Detail
  - isNegation
```
public boolean isNegation()
```
    Return true if the transform negates the azimuth values of transformed points, regardless of any rotation applied subsequently.
    
    Returns:
    
    true if the transform negates the azimuth values of transformed points
    
    See Also:
    
    preservesOrientation()
  - getRotation
```
public double getRotation()
```
    Get the rotation value applied by this instance, in radians.
    
    Returns:
    
    the rotation value applied by this instance, in radians.
  - apply
```
public Point1S apply(Point1S pt)
```
    Specified by:
    
    apply in interface Function<Point1S,Point1S>
  - preservesOrientation
```
public boolean preservesOrientation()
```
    Specified by:
    
    preservesOrientation in interface Transform<Point1S>
  - rotate
```
public Transform1S rotate(double angle)
```
    Return a new transform created by pre-multiplying this instance by a transform producing a rotation with the given angle.
    
    Parameters:
    
    angle - angle to rotate, in radians
    
    Returns:
    
    a new transform created by pre-multiplying this instance by a transform producing a rotation with the given angle
    
    See Also:
    
    createRotation(double)
  - negate
```
public Transform1S negate()
```
    Return a new transform created by pre-multiplying this instance by a transform that negates azimuth values.
    
    Returns:
    
    a new transform created by pre-multiplying this instance by a transform that negates azimuth values
  - multiply
```
public Transform1S multiply(Transform1S other)
```
    Multiply the underlying matrix of this instance by that of the argument, eg, other * this. The returned transform performs the equivalent of other followed by this.
    
    Parameters:
    
    other - transform to multiply with
    
    Returns:
    
    a new transform computed by multiplying the matrix of this instance by that of the argument
  - premultiply
```
public Transform1S premultiply(Transform1S other)
```
    Multiply the underlying matrix of the argument by that of this instance, eg, this * other. The returned transform performs the equivalent of this followed by other.
    
    Parameters:
    
    other - transform to multiply with
    
    Returns:
    
    a new transform computed by multiplying the matrix of the argument by that of this instance
  - inverse
```
public Transform1S inverse()
```
    Specified by:
    
    inverse in interface Transform<Point1S>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Return true if the given object is an instance of Transform1S and all transform element values are exactly equal.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    obj - object to test for equality with the current instance
    
    Returns:
    
    true if all transform elements are exactly equal; otherwise false
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - identity
```
public static Transform1S identity()
```
    Return a transform instance representing the identity transform.
    
    Specified by:
    
    identity in interface Function<Point1S,Point1S>
    
    Specified by:
    
    identity in interface UnaryOperator<Point1S>
    
    Returns:
    
    a transform instance representing the identity transform
  - createNegation
```
public static Transform1S createNegation()
```
    Return a transform instance that negates azimuth values.
    
    Returns:
    
    a transform instance that negates azimuth values.
  - createRotation
```
public static Transform1S createRotation(double angle)
```
    Return a transform instance that performs a rotation with the given angle.
    
    Parameters:
    
    angle - angle of the rotation, in radians
    
    Returns:
    
    a transform instance that performs a rotation with the given angle

Class Transform1S

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.function.Function

Method Detail

isNegation

getRotation

apply

preservesOrientation

rotate

negate

multiply

premultiply

inverse

hashCode

equals

toString

identity

createNegation

createRotation