ArrayVect3f (Mines Java Toolkit)

java.lang.Object
- edu.mines.jtk.opt.ArrayVect3f

All Implemented Interfaces:

Vect, VectConst, java.io.Serializable, java.lang.Cloneable
```
public class ArrayVect3f
extends java.lang.Object
implements Vect
```
Implement a Vect as a three-dimensional array of floats. The embedded data are exposed by a getData method. For all practical purposes this member is public, except that this class must always point to the same array. The implementation as an array is the point of this class, to avoid duplicate implementations elsewhere. Multiple inheritance is prohibited and prevents the mixin pattern, but you can share the wrapped array as a private member of your own class, and easily delegate all implemented methods.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected float[][][] _data
wrapped data

protected double _variance
variance for all samples

Fields
Modifier and Type	Field and Description
`protected float[][][]`	`_data` wrapped data
`protected double`	`_variance` variance for all samples

Constructor Summary

Constructors
Modifier Constructor and Description

protected ArrayVect3f()
To be used with init()

ArrayVect3f(float[][][] data, double variance)
Wrap an array as a Vect.

Constructors
Modifier	Constructor and Description
`protected`	`ArrayVect3f()` To be used with init()
	`ArrayVect3f(float[][][] data, double variance)` Wrap an array as a Vect.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`add(double scaleThis, double scaleOther, VectConst other)` Add a scaled version of another vector to a scaled version of this vector.
`ArrayVect3f`	`clone()`
`void`	`constrain()` Optionally apply a hard constraint (such as an inequality) to the current vector.
`void`	`dispose()` Optionally free any resources held by this object.
`double`	`dot(VectConst other)` Return the Cartesian dot product of this vector with another vector (not including any inverse covariance).
`float[][][]`	`getData()` Get the embedded data.
`int`	`getSize()` Return the size of the embedded array
`double`	`getVariance()` Get the value of the variance passed to the constructor.
`protected void`	`init(float[][][] data, double variance)` Wrap an array as a Vect.
`double`	`magnitude()` This is the dot product of the vector with itself premultiplied by the inverse covariance.
`void`	`multiplyInverseCovariance()` Optionally multiply a vector by the inverse covariance matrix.
`void`	`postCondition()` Apply a linear filter that enhances components that should be optimized first, and suppresses components of lesser importance.
`void`	`project(double scaleThis, double scaleOther, VectConst other)` Project another vector onto the space of this vector, then scale, and add to a scaled version of this vector.

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

- Field Detail
  - _data
```
protected transient float[][][] _data
```
    wrapped data
  - _variance
```
protected transient double _variance
```
    variance for all samples
- Constructor Detail
  - ArrayVect3f
```
public ArrayVect3f(float[][][] data,
           double variance)
```
    Wrap an array as a Vect.
    
    Parameters:
    data - This will be assigned to the public data.
    variance - This variance will be used to divide data in multiplyInverseCovariance.
  - ArrayVect3f
```
protected ArrayVect3f()
```
    To be used with init()
- Method Detail
  - getVariance
```
public double getVariance()
```
    Get the value of the variance passed to the constructor.
    
    Returns:
    This variance will be used to divide data in multiplyInverseCovariance.
  - init
```
protected final void init(float[][][] data,
        double variance)
```
    Wrap an array as a Vect.
    
    Parameters:
    data - This will be assigned to the public data.
    variance - This variance will be used to divide data in multiplyInverseCovariance.
  - getData
```
public float[][][] getData()
```
    Get the embedded data.
    
    Returns:
    Same array as passed to constructore.
  - getSize
```
public int getSize()
```
    Return the size of the embedded array
    
    Returns:
    size of embedded array
  - add
```
public void add(double scaleThis,
       double scaleOther,
       VectConst other)
```
    Description copied from interface: Vect
    
    Add a scaled version of another vector to a scaled version of this vector. [If this==other, then the result should be the same as scaling this by (scaleThis+scaleOther)]
    
    Specified by:
    
    add in interface Vect
    
    Parameters:
    scaleThis - Multiply this vector by this scalar before adding.
    scaleOther - Multiply the other vector by this scalar before adding.
    other - The other vector to be multiplied.
  - project
```
public void project(double scaleThis,
           double scaleOther,
           VectConst other)
```
    Description copied from interface: Vect
    
    Project another vector onto the space of this vector, then scale, and add to a scaled version of this vector. (Useful for perturbing one vector with a constrained subspace.) This method should give the same result as add(), if the other Vect is an instance of the same class as this Vect. This operation need not be supported for any any types other than this Vect.
    
    Specified by:
    
    project in interface Vect
    
    Parameters:
    scaleThis - Multiply this vector by this scalar before adding.
    scaleOther - Multiply the other vector by this scalar before adding.
    other - The other vector to be projected, scaled, and added.
  - dispose
```
public void dispose()
```
    Description copied from interface: Vect
    
    Optionally free any resources held by this object. Will not be used again. This method can safely do nothing.
    
    Specified by:
    
    dispose in interface Vect
  - multiplyInverseCovariance
```
public void multiplyInverseCovariance()
```
    Description copied from interface: Vect
    
    Optionally multiply a vector by the inverse covariance matrix. Also called preconditioning. A method that does nothing is equivalent to an identity. [vect.magnitude() should return the same value as vect.dot(((Vect)vect.clone()).multiplyInverseCovariance()); This should enhance components that should be discouraged in the model and suppress components that are preferred. This operation slows convergence. This filter must be linear. For inversions, you should at least implement a scaling operation that correctly weights errors in the data versus the magnitude of the model.]
    
    Specified by:
    
    multiplyInverseCovariance in interface Vect
  - magnitude
```
public double magnitude()
```
    Description copied from interface: VectConst
    This is the dot product of the vector with itself premultiplied by the inverse covariance. If the inverse covariance is an identity, then the result is just the dot product with itself. Equivalently,
```
 Vect vect = (Vect) this.clone();
 vect.multiplyInverseCovariance();
 return this.dot(vect);
 
```
    But you can usually avoid the clone.
    Specified by:
    
    magnitude in interface VectConst
    
    Returns:
    magnitude of vector.
  - constrain
```
public void constrain()
```
    Description copied from interface: Vect
    
    Optionally apply a hard constraint (such as an inequality) to the current vector. This is used only by a non-linear optimization. This method can safely do nothing.
    
    Specified by:
    
    constrain in interface Vect
  - postCondition
```
public void postCondition()
```
    Description copied from interface: Vect
    
    Apply a linear filter that enhances components that should be optimized first, and suppresses components of lesser importance. Also called post-conditioning. This filter prefilters all perturbations of the model and speeds convergence on components of most importance in the model. The same result can be accomplished by Transform.inverseHessian(), but this location may be more convenient. Use this location if the conditioning is independent of the Transform and dependent on the implementation of the model. This method can safely do nothing.
    
    Specified by:
    
    postCondition in interface Vect
  - clone
```
public ArrayVect3f clone()
```
    Specified by:
    
    clone in interface Vect
    
    Specified by:
    
    clone in interface VectConst
    
    Overrides:
    
    clone in class java.lang.Object
  - dot
```
public double dot(VectConst other)
```
    Description copied from interface: VectConst
    
    Return the Cartesian dot product of this vector with another vector (not including any inverse covariance). [Feel free to normalize by the number of elements in the array, if the inverse convariance is defined consistently.]
    
    Specified by:
    
    dot in interface VectConst
    
    Parameters:
    other - The vector to be dotted.
    
    Returns:
    The dot product.

Class ArrayVect3f

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_data

_variance

Constructor Detail

ArrayVect3f

ArrayVect3f

Method Detail

getVariance

init

getData

getSize

add

project

dispose

multiplyInverseCovariance

magnitude

constrain

postCondition

clone

dot