ATransform (Vectorz 0.62.0 API)

java.lang.Object
- mikera.transformz.ATransform

All Implemented Interfaces:

Cloneable, ITransform

Direct Known Subclasses:

AAffineTransform, AOpTransform, ASizedTransform, CompoundTransform, ScalarFunction, SubsetTransform, VectorFunction
```
public abstract class ATransform
extends Object
implements Cloneable, ITransform
```
Abstract base class for all vector transformations. A transformation is defined as any function mapping an N-dimensional vector to an M-dimensional vector.

Author:

Mike

Constructor Summary

Constructors
Constructor and Description

ATransform()

Constructors
Constructor and Description
`ATransform()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`double`	`calculateElement(int i, AVector inputVector)` Calculates a single element of the output.
`ATransform`	`clone()` Clones the transform, performing a deep copy where needed
`ATransform`	`compose(ATransform trans)` Composes this transformation with another transformation, returning a new combined transformation
`void`	`composeWith(ATransform trans)` Composes this transformation with a given transformation, mutating the transformation to represent the combined transform
`abstract int`	`inputDimensions()` Returns the number of dimensions required for input vectors
`ATransform`	`inverse()` Return the inverse of this transformation (if possible).
`boolean`	`isIdentity()` Returns true if this transform is known to be the identity function, i.e.
`boolean`	`isInvertible()` Returns true if this transform is invertible
`boolean`	`isLinear()` Returns true if this transformation is guaranteed to be linear
`boolean`	`isSquare()` Returns true if the transform is square (same number of input and output dimensions)
`abstract int`	`outputDimensions()` Returns the number of dimensions required for output vectors
`ATransform`	`takeComponents(Index components)` Returns a wrapper transform that returns a subset of this transform's output components
`ATransform`	`takeComponents(int length)` Returns a wrapper transform that returns a subset of this transform's output components
`ATransform`	`takeComponents(int start, int length)` Returns a wrapper transform that returns a subset of this transform's output components
`AVector`	`transform(AVector v)` Transforms a vector, returning a new transformed vector
`abstract void`	`transform(AVector source, AVector dest)` Transforms the source vector, storing the result in the given destination vector
`Vector`	`transform(Vector v)` Transforms a vector, returning a new transformed vector
`void`	`transformInPlace(AVector v)` Transforms a vector destructively.

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

- Constructor Detail
  - ATransform
```
public ATransform()
```
- Method Detail
  - transform
```
public abstract void transform(AVector source,
                               AVector dest)
```
    Description copied from interface: ITransform
    
    Transforms the source vector, storing the result in the given destination vector
    
    Specified by:
    
    transform in interface ITransform
  - inputDimensions
```
public abstract int inputDimensions()
```
    Description copied from interface: ITransform
    
    Returns the number of dimensions required for input vectors
    
    Specified by:
    
    inputDimensions in interface ITransform
    
    Returns:
  - outputDimensions
```
public abstract int outputDimensions()
```
    Description copied from interface: ITransform
    
    Returns the number of dimensions required for output vectors
    
    Specified by:
    
    outputDimensions in interface ITransform
    
    Returns:
  - clone
```
public ATransform clone()
```
    Clones the transform, performing a deep copy where needed
    
    Overrides:
    
    clone in class Object
  - compose
```
public ATransform compose(ATransform trans)
```
    Composes this transformation with another transformation, returning a new combined transformation
  - composeWith
```
public void composeWith(ATransform trans)
```
    Composes this transformation with a given transformation, mutating the transformation to represent the combined transform
  - isLinear
```
public boolean isLinear()
```
    Returns true if this transformation is guaranteed to be linear
    
    Returns:
  - isSquare
```
public boolean isSquare()
```
    Returns true if the transform is square (same number of input and output dimensions)
    
    Returns:
  - transform
```
public AVector transform(AVector v)
```
    Transforms a vector, returning a new transformed vector
    
    Parameters:
    
    v -
    
    Returns:
  - transform
```
public Vector transform(Vector v)
```
    Transforms a vector, returning a new transformed vector
    
    Parameters:
    
    v -
    
    Returns:
  - calculateElement
```
public double calculateElement(int i,
                               AVector inputVector)
```
    Calculates a single element of the output. Not necessarily faster than calculating full output, but can be in some circumstances.
  - transformInPlace
```
public void transformInPlace(AVector v)
```
    Transforms a vector destructively. Intended for fast non-allocating transforms
    
    Parameters:
    
    v -
  - isIdentity
```
public boolean isIdentity()
```
    Returns true if this transform is known to be the identity function, i.e. it maps all vectors to themselves
  - takeComponents
```
public ATransform takeComponents(int length)
```
    Returns a wrapper transform that returns a subset of this transform's output components
  - takeComponents
```
public ATransform takeComponents(int start,
                                 int length)
```
    Returns a wrapper transform that returns a subset of this transform's output components
  - takeComponents
```
public ATransform takeComponents(Index components)
```
    Returns a wrapper transform that returns a subset of this transform's output components
  - inverse
```
public ATransform inverse()
```
    Return the inverse of this transformation (if possible). Throws an exception if the inverse cannot be computed.
    
    Returns:
  - isInvertible
```
public boolean isInvertible()
```
    Returns true if this transform is invertible

Class ATransform

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ATransform

Method Detail

transform

inputDimensions

outputDimensions

clone

compose

composeWith

isLinear

isSquare

transform

transform

calculateElement

transformInPlace

isIdentity

takeComponents

takeComponents

takeComponents

inverse

isInvertible