DblMatrix (Snifflib API)

java.lang.Object
- com.mockturtlesolutions.snifflib.datatypes.GenMatrix
- - com.mockturtlesolutions.snifflib.datatypes.DblMatrix

All Implemented Interfaces:

Displayable, DOMUpdateable, java.io.Serializable

Direct Known Subclasses:

SblMatrix
```
public class DblMatrix
extends GenMatrix
implements Displayable, DOMUpdateable, java.io.Serializable
```
DblMatrix is an ND matrix class.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`Counter`	`Counter`
`static DblMatrix`	`E`
`static DblMatrix`	`HALF`
`static DblMatrix`	`INF`
`int[]`	`IPermute`
`static DblMatrix`	`NaN`
`static DblMatrix`	`NEGATIVE_INFINITY`
`static DblMatrix`	`ONE`
`int[]`	`Permute`
`static DblMatrix`	`PI`
`static DblMatrix`	`POSITIVE_INFINITY`
`static DblMatrix`	`SQRT2`
`static DblMatrix`	`TWO`
`static DblMatrix`	`ZERO`

Fields inherited from class com.mockturtlesolutions.snifflib.datatypes.GenMatrix
EmptyValue, setget, Size

Constructor Summary

Constructors
Constructor and Description
`DblMatrix()`
`DblMatrix(DblMatrix X)` This construction creates a new DblMatrix from an input DblMatrix.
`DblMatrix(double val)`
`DblMatrix(java.lang.Double value)` This construction creates a scalar matrix from an Double's value.
`DblMatrix(java.lang.Double[] arr, int[] siz)`
`DblMatrix(int Nelements)`
`DblMatrix(int[] Size)`
`DblMatrix(java.lang.Integer value)` This construction creates a scalar matrix from an Integer's value.
`DblMatrix(java.util.Iterator I, int N)` This construction creates a new DblMatrix column vector from an Iterator over Double's.
`DblMatrix(java.util.Iterator I, int[] Size)` This construction creates a new DblMatrix of dimension Size from an Iterator over Double's.
`DblMatrix(MatrixSetterGetter sg)`
`DblMatrix(MatrixSetterGetter sg, DblMatrix X)` This construction creates a new DblMatrix from an input DblMatrix.
`DblMatrix(MatrixSetterGetter sg, java.lang.Double value)` This construction creates a scalar matrix from an Double's value.
`DblMatrix(MatrixSetterGetter sg, int Nelements)` This construction creates an Nx1 matrix.
`DblMatrix(MatrixSetterGetter sg, int[] Siz)` This construction creates a matrix of certain size.
`DblMatrix(MatrixSetterGetter sg, java.lang.Integer value)` This construction creates a scalar matrix from an Integer's value.
`DblMatrix(MatrixSetterGetter sg, java.util.Iterator I, int N)` This construction creates a new DblMatrix column vector from an Iterator over Double's.
`DblMatrix(MatrixSetterGetter sg, java.util.Iterator I, int[] Size)` This construction creates a new DblMatrix of dimension Size from an Iterator over Double's.
`DblMatrix(MatrixSetterGetter sg, java.lang.String inputstr)` This should be rewritten to accept a character stream.
`DblMatrix(java.lang.String inputstr)`
`DblMatrix(java.util.Vector d)` Creates a column vector from a Vector of Doubles.

Method Summary

Methods
Modifier and Type	Method and Description
`static DblMatrix`	`abs(DblMatrix Y)`
`static DblMatrix`	`acos(DblMatrix Y)`
`static DblMatrix`	`acosh(DblMatrix Y)`
`static DblMatrix`	`acoth(DblMatrix Y)`
`static DblMatrix`	`acsch(DblMatrix Y)`
`static DblMatrix`	`add(double X, DblMatrix Y)`
`static DblMatrix`	`add(int X, DblMatrix Y)`
`void`	`addhighsingletons(int dim)`
`static DblMatrix`	`all(DblMatrix X)` Boolean "all" down dimension 1.
`static DblMatrix`	`All(DblMatrix X)` Boolean "all" inclusive of all values.
`static DblMatrix`	`all(DblMatrix X, int dim)` Boolean "all" down dimension dim.
`DblMatrix`	`and(DblMatrix Z)` "And" one matrix with another.
`static DblMatrix`	`and(DblMatrix Z, DblMatrix X)` "And" one matrix with another.
`static DblMatrix`	`and(DblMatrix Z, double X)` "And" one matrix with another.
`static DblMatrix`	`and(DblMatrix Z, int X)` "And" one matrix with another.
`static DblMatrix`	`and(double X, DblMatrix Z)` "And" one matrix with another.
`static DblMatrix`	`and(int X, DblMatrix Z)` "And" one matrix with another.
`static DblMatrix`	`anscombe(DblMatrix X)` Performs Anscombe transformation.
`static DblMatrix`	`anscombe(java.lang.Double X)`
`static DblMatrix`	`any(DblMatrix X)` Boolean "any" down dimension 1.
`static DblMatrix`	`Any(DblMatrix X)` Boolean "any" inclusive of all values.
`static DblMatrix`	`any(DblMatrix X, int dim)` Boolean "any" down dimension dim.
`static DblMatrix`	`asech(DblMatrix Y)`
`static DblMatrix`	`asin(DblMatrix Y)`
`static DblMatrix`	`asinh(DblMatrix Y)`
`static DblMatrix`	`atan(DblMatrix Y)`
`static DblMatrix`	`atan2(DblMatrix Y, DblMatrix X)`
`static DblMatrix`	`atanh(DblMatrix Y)`
`DblMatrix`	`bounds()` Return the smallest and largest values in a matrix.
`static DblMatrix`	`bounds(DblMatrix X)` Return the smallest and largest values in a matrix.
`static DblMatrix`	`cbrt(DblMatrix Y)`
`protected DblMatrix`	`cccopy()` Copy using the current counter configuration.
`static DblMatrix`	`ceil(DblMatrix Y)`
`static DblMatrix`	`comp(DblMatrix u, DblMatrix v)` Return the scalar projection (or component) of u onto v.
`DblMatrix`	`concat(DblMatrix B, int dim)`
`static java.lang.String`	`convertDblToString(DblMatrix in)`
`static DblMatrix`	`convertStringToDbl(java.lang.String in)`
`DblMatrix`	`copy()` Make a deep copy of the matrix.
`static DblMatrix`	`copySign(DblMatrix X, DblMatrix Y)`
`static DblMatrix`	`copySign(DblMatrix X, double b)`
`static DblMatrix`	`copySign(DblMatrix X, float Y)`
`static DblMatrix`	`copySign(DblMatrix X, int Y)`
`static DblMatrix`	`cos(DblMatrix Y)`
`static DblMatrix`	`cosh(DblMatrix Y)`
`static DblMatrix`	`coth(DblMatrix Y)`
`static DblMatrix`	`csc(DblMatrix Y)`
`static DblMatrix`	`csch(DblMatrix Y)`
`DblMatrix`	`cumProd(int dim)` Calculate the cummulative product down the given dimension.
`DblMatrix`	`cumSum(int dim)` Calculate the cummulative sum down the given dimension.
`static DblMatrix`	`degreesToRadians(DblMatrix x)`
`static DblMatrix`	`degreesToRadians(double x)`
`static DblMatrix`	`degreesToRadians(int x)`
`void`	`describe()` Print the dimensions of the matrix.
`void`	`describe(java.lang.String Label)` Print the dimensions of the matrix.
`static DblMatrix`	`det(DblMatrix X)` Returns the determinant of the square matrix.
`DblMatrix`	`diag()` Get main diagonal elements of an ND matrix.
`DblMatrix`	`diag(int diagonal)` Get particular diagonal.
`static DblMatrix`	`diameter(DblMatrix X)` The maximum euclidean distance between columns in a matrix.
`static DblMatrix`	`divide(double X, DblMatrix Y)`
`static DblMatrix`	`divide(int X, DblMatrix Y)`
`DblMatrix`	`divideBy(DblMatrix X)` Divide one matrix by another.
`DblMatrix`	`divideBy(double X)` Divide one matrix by another.
`DblMatrix`	`divideBy(java.lang.Double X)` Divide one matrix by another.
`DblMatrix`	`divideBy(int X)` Divide one matrix by another.
`DblMatrix`	`dot(DblMatrix X)` Dot product of two matrices.
`static DblMatrix`	`dummyCoding(DblMatrix X)` Produces a dummy-variable encoding matrix based on the unique values of the input array.
`static DblMatrix`	`dummyCoding(DblMatrix X, boolean intercept)` Produces a dummy-variable encoding matrix based on the unique values of the input array.
`static DblMatrix`	`dummyCoding(DblMatrix X, boolean intercept, boolean fullrank)` Produces a dummy-variable encoding matrix based on the unique values of the input array.
`DblMatrix`	`eq(DblMatrix X)` Boolean equality comparison.
`DblMatrix`	`eq(double X)` Boolean inequality comparison determining equal-to.
`DblMatrix`	`eq(int X)` Boolean inequality comparison determining equal-to.
`static DblMatrix`	`euclid(DblMatrix X)` Euclidean distance among columns.
`static DblMatrix`	`exp(DblMatrix Y)`
`static DblMatrix`	`expm1(DblMatrix Y)`
`static DblMatrix`	`factorial(DblMatrix X)`
`static DblMatrix`	`factorial(double X)`
`static DblMatrix`	`factorial(int X)`
`static DblMatrix`	`fill(DblMatrix X, int[] Size)` Create a matrix of arbitrary dimension filled with the same value.
`static DblMatrix`	`fill(double X, int[] Size)` Create a matrix of arbitrary dimension filled with the same value.
`static DblMatrix`	`fill(java.lang.Double X, int[] Size)` Create a matrix of arbitrary dimension filled with the same value.
`static DblMatrix`	`fill(int X, int[] Size)` Create a matrix of arbitrary dimension filled with the same value.
`static DblMatrix`	`find(DblMatrix X)`
`int`	`findMax()`
`int`	`findMin()`
`DblMatrix`	`fliplr()` Reverses order of matrix elements in left-to-right.
`DblMatrix`	`flipud()` Reverses order of matrix elements in top-to-bottom.
`static DblMatrix`	`floor(DblMatrix Y)`
`void`	`fromArray(java.lang.Double[] C)` Replaces the contents with a given Double[].
`static DblMatrix`	`gap(DblMatrix u, DblMatrix v)` Returns the cosine of the angle between the two input vectors.
`DblMatrix`	`geq(DblMatrix X)` Boolean inequality comparison determining greater-than-or-equal-to.
`DblMatrix`	`geq(double X)` Boolean inequality comparison determining greater-than-or-equal-to.
`DblMatrix`	`geq(int X)` Boolean inequality comparison determining greater-than-or-equal-to.
`java.lang.Object`	`get(int element)`
`DblMatrix`	`getCol(DblMatrix col)` Get a particular col.
`DblMatrix`	`getCol(int col)` Get a particular col.
`java.lang.Double`	`getCurrentValue()`
`DblMatrix`	`getDblAt(int k)` Return the scalar DblMatrix at a particular index.
`java.lang.Double`	`getDoubleAt(int k)` Return the Double at a particular index.
`static DblMatrix`	`getExponent(DblMatrix Y)`
`DblMatrix`	`getIndices(DblMatrix I)` Get values whose indices are given in a DblMatrix.
`DblMatrix`	`getIndices(int[] I)` Get values whose indices are given.
`DblMatrix`	`getMap(DblMatrix MAP)` Get values from a matrix based on a logical map.
`static DblMatrix`	`getNextRow(java.io.StreamTokenizer STT)`
`static java.beans.PersistenceDelegate`	`getPersistenceDelegate()`
`DblMatrix`	`getRow(DblMatrix row)` Get a particular row.
`DblMatrix`	`getRow(int row)` Get a particular row.
`int`	`getSize(int dim)`
`DblMatrix`	`getSubMatrix(Subscript[] subscripts)` Get a matrix of values by sub-indexing into an existing matrix.
`static DblMatrix[]`	`GramSchmidt(DblMatrix[] u)`
`static DblMatrix[]`	`grid(DblMatrix[] X)`
`static DblMatrix[]`	`grid(DblMatrix X1, DblMatrix X2)`
`static DblMatrix[]`	`grid(DblMatrix X1, DblMatrix X2, DblMatrix X3)`
`DblMatrix`	`gt(DblMatrix X)` Boolean inequality comparison determining greater-than.
`DblMatrix`	`gt(double X)` Boolean inequality comparison determining greater-than.
`DblMatrix`	`gt(int X)` Boolean inequality comparison determining greater-than.
`static DblMatrix`	`hypot(DblMatrix X, DblMatrix Y)`
`static DblMatrix`	`hypot(double x, double y)`
`static DblMatrix`	`hypot(java.lang.Double x, java.lang.Double y)`
`static DblMatrix`	`I(DblMatrix X)` Create square identity matrix with N rows.
`static DblMatrix`	`I(int N)` Create square identity matrix with N rows.
`static DblMatrix`	`I(int[] size)` Create rectangular identity matrix with given size.
`static DblMatrix`	`ianscombe(DblMatrix X)`
`static DblMatrix`	`ianscombe(java.lang.Double X)`
`static DblMatrix`	`IEEEremainder(DblMatrix Y, DblMatrix X)` Calculate remainder.
`static DblMatrix`	`IEEEremainder(DblMatrix Y, double X)`
`static DblMatrix`	`IEEEremainder(DblMatrix Y, int X)`
`static Subscript[]`	`indexToSubscript(DblMatrix I, int[] Size)` Convert an index array into a Subscript[] for a given matrix Size
`Subscript[]`	`indexToSubscript(int I)` Convert an index array into a Subscript[]
`Subscript[]`	`indexToSubscript(int[] I)` Convert an index array into a Subscript[]
`static Subscript[]`	`indexToSubscript(int[] I, int[] Size)` Convert an index array into a Subscript[] for a given matrix Size
`static Subscript[]`	`indexToSubscript(int I, int[] Size)` Convert an index array into a Subscript[] for a given matrix Size
`DblMatrix`	`iPermute(int[] Perm)`
`boolean`	`isEqual(GenMatrix X)`
`static boolean`	`isEqualSize(DblMatrix X, DblMatrix Y)`
`static DblMatrix`	`isInfinite(DblMatrix X)` Boolean isInfinite
`static DblMatrix`	`isNaN(DblMatrix X)` Boolean isNaN
`static DblMatrix`	`isReal(DblMatrix X)` Boolean isReal Determines if elements are not NaN nor Infinite;
`boolean`	`isScalar()` Return true if the matrix is 1-by-1 matrix.
`static DblMatrix`	`isScalar(DblMatrix X)` Determine if a matrix is sized 1x1.
`static DblMatrix`	`J(DblMatrix X)` Create a column vector of ones.
`static DblMatrix`	`J(int N)` Create a column vector of ones.
`DblMatrix`	`kronecker(DblMatrix X)` Returns Kronecker product taken with respect to the input matrix.
`DblMatrix`	`leq(DblMatrix X)` Boolean inequality comparison determining less-than-or-equal-to.
`DblMatrix`	`leq(double X)` Boolean inequality comparison determining less-than-or-equal-to.
`DblMatrix`	`leq(int X)` Boolean inequality comparison determining less-than-or-equal-to.
`static DblMatrix`	`load(java.io.File dat)` Loads the whitespace-delimited text file as a DblMatrix.
`static DblMatrix`	`load(java.io.File dat, int headerlines)` Loads the whitespace-delimited text file as a DblMatrix ignoring the first N lines.
`static DblMatrix`	`log(DblMatrix Y)`
`static DblMatrix`	`log(double Y)`
`static DblMatrix`	`log(java.lang.Double Y)`
`static DblMatrix`	`log(int Y)`
`static DblMatrix`	`log10(DblMatrix Y)`
`static DblMatrix`	`log10(double Y)`
`static DblMatrix`	`log10(java.lang.Double Y)`
`static DblMatrix`	`log10(int Y)`
`static DblMatrix`	`log1p(DblMatrix Y)`
`static DblMatrix`	`log1p(double Y)`
`static DblMatrix`	`log1p(java.lang.Double Y)`
`static DblMatrix`	`log1p(int Y)`
`static DblMatrix`	`logGamma(DblMatrix x)`
`static DblMatrix`	`logGamma(double x)`
`static DblMatrix`	`logGamma(int x)`
`static DblMatrix`	`logxy(DblMatrix X, DblMatrix Y)` Log base x of y.
`static DblMatrix`	`logxy(double X, double Y)` Log base x of y.
`static DblMatrix`	`logxy(double X, java.lang.Double Y)` Log base x of y.
`static DblMatrix`	`logxy(double X, int Y)` Log base x of y.
`static DblMatrix`	`logxy(int X, int Y)` Log base x of y.
`DblMatrix`	`lt(DblMatrix X)` Boolean inequality comparison determining less-than.
`DblMatrix`	`lt(double X)` Boolean inequality comparison determining less-than.
`DblMatrix`	`lt(int X)` Boolean inequality comparison determining less-than.
`static Subscript[]`	`mapToSubscript(DblMatrix MAP)` Return Subscript[] indicating the non-zero entries of a DblMatrix.
`DblMatrix`	`max()` Calculate maximum down the first dimension.
`DblMatrix`	`Max()` Calculate the grand maximum (over all elements)
`DblMatrix`	`max(DblMatrix X)` Calculate maximum between two matrices.
`static DblMatrix`	`Max(DblMatrix X)` Calculate the grand maximum (over all elements)
`static DblMatrix`	`max(DblMatrix X, DblMatrix Y)` Return maximum between two matrices.
`static DblMatrix`	`max(DblMatrix X, double Y)` Return maximum between a matrix and a scalar.
`static DblMatrix`	`max(DblMatrix X, java.lang.Double Y)` Return maximum between a matrix and a scalar.
`static DblMatrix`	`max(DblMatrix X, int dim)` Calculate maximum down the specified dimension.
`static DblMatrix`	`max(double X, DblMatrix Y)`
`DblMatrix`	`max(int dim)` Calculate maximum down the specified dimension.
`DblMatrix`	`mean()` Calculate mean down the first dimension.
`DblMatrix`	`Mean()` Calculate the grand mean (over all elements)
`static DblMatrix`	`Mean(DblMatrix X)` Calculate the grand mean (over all elements)
`DblMatrix`	`mean(int dim)` Calculate mean down the specified dimension.
`DblMatrix`	`Median()` Median of all elements
`static DblMatrix`	`median(DblMatrix X)` Median of all elements
`static DblMatrix`	`Median(DblMatrix X)` Median of all elements
`DblMatrix`	`min()` Calculate minimum down the first dimension.
`DblMatrix`	`Min()` Calculate the grand minimum (over all elements)
`DblMatrix`	`min(DblMatrix X)` Calculate minimum between two matrices.
`static DblMatrix`	`Min(DblMatrix X)` Calculate the grand minimum (over all elements)
`static DblMatrix`	`min(DblMatrix X, DblMatrix Y)` Return minimum between two matrices.
`static DblMatrix`	`min(DblMatrix Y, double X)`
`static DblMatrix`	`min(DblMatrix X, java.lang.Double Y)` Return minimum between a matrix and a scalar.
`static DblMatrix`	`min(DblMatrix Y, int X)`
`static DblMatrix`	`min(DblMatrix Y, java.lang.Number X)`
`static DblMatrix`	`min(double X, DblMatrix Y)`
`DblMatrix`	`min(int dim)` Calculate minimum down the specified dimension.
`static DblMatrix`	`min(int X, DblMatrix Y)`
`static DblMatrix`	`min(java.lang.Number X, DblMatrix Y)`
`DblMatrix`	`minus(DblMatrix X)` Subtract input matrix from this matrix.
`DblMatrix`	`minus(double X)` Subtract input matrix from this matrix.
`DblMatrix`	`minus(int X)` Subtract input matrix from this matrix.
`static DblMatrix`	`mod(DblMatrix X, DblMatrix Y)` Modulo of X after division by Y.
`static DblMatrix`	`mod(DblMatrix X, double Y)` Modulo of X after division by Y.
`static DblMatrix`	`mod(DblMatrix X, java.lang.Double Y)` Modulo of X after division by Y.
`static DblMatrix`	`mod(DblMatrix X, int Y)` Modulo of X after division by Y.
`static DblMatrix`	`multiply(double X, DblMatrix Y)`
`static DblMatrix`	`multiply(int X, DblMatrix Y)`
`static DblMatrix`	`nchoosek(DblMatrix N, DblMatrix k)`
`static DblMatrix`	`nchoosek(double N, double k)`
`static DblMatrix`	`nchoosek(int N, int k)`
`DblMatrix`	`neq(DblMatrix X)` Boolean equality comparison determining not-equal-to.
`DblMatrix`	`neq(double X)` Boolean inequality comparison determining not-equal-to.
`DblMatrix`	`neq(int X)` Boolean inequality comparison determining not-equal-to.
`static DblMatrix`	`nextAfter(DblMatrix X, DblMatrix Y)` Returns the floating-point number adjacent to the first argument in the direction of the second argument.
`static DblMatrix`	`nextAfter(DblMatrix X, double y)` Returns the floating-point number adjacent to the first argument in the direction of the second argument.
`static DblMatrix`	`nextAfter(DblMatrix X, float b)` Returns the floating-point number adjacent to the first argument in the direction of the second argument.
`static DblMatrix`	`nextAfter(double y, DblMatrix X)` Returns the floating-point number adjacent to the first argument in the direction of the second argument.
`static DblMatrix`	`nextAfter(float b, DblMatrix X)` Returns the floating-point number adjacent to the first argument in the direction of the second argument.
`static DblMatrix`	`nextUp(DblMatrix X)` Returns the floating-point value adjacent to d in the direction of positive infinity.
`DblMatrix`	`nzDivideBy(DblMatrix X)` Divide one matrix by another.
`DblMatrix`	`nzDivideBy(double X)` Divide one matrix by another.
`DblMatrix`	`nzDivideBy(java.lang.Double X)` Divide one matrix by another.
`DblMatrix`	`nzDivideBy(int X)` Divide one matrix by another.
`static DblMatrix`	`oldload(java.io.File dat, int headerlines)` Loads the whitespace-delimited text file as a DblMatrix ignoring the first N lines.
`DblMatrix`	`optDivideBy(DblMatrix X, boolean nodividebyzero)` Divide one matrix by another.
`DblMatrix`	`optDivideBy(double X, boolean nodividebyzero)` Divide one matrix by another.
`DblMatrix`	`optDivideBy(java.lang.Double X, boolean nodividebyzero)` Divide one matrix by another.
`DblMatrix`	`optDivideBy(int X, boolean nodividebyzero)` Divide one matrix by another.
`DblMatrix`	`or(DblMatrix Z)` "Or" one matrix with another.
`static DblMatrix`	`or(DblMatrix Z, DblMatrix X)` "Or" one matrix with another.
`static DblMatrix`	`or(DblMatrix Z, double X)` "Or" one matrix with another.
`static DblMatrix`	`or(DblMatrix Z, int X)` "Or" one matrix with another.
`static DblMatrix`	`or(double X, DblMatrix Z)` "Or" one matrix with another.
`static DblMatrix`	`or(int X, DblMatrix Z)` "Or" one matrix with another.
`static DblMatrix`	`orth(DblMatrix u)` Return a vector orthogonal to the given vector.
`static DblMatrix`	`orth(DblMatrix[] u)` Return a vector orthogonal to the spanning set of vectors.
`static DblMatrix`	`parse(java.lang.String s)` Static method to parse a string into a DblMatrix.
`DblMatrix`	`permute(int[] Perm)`
`DblMatrix`	`plus(DblMatrix X)` Add one matrix to another.
`DblMatrix`	`plus(double X)` Add one matrix to another.
`DblMatrix`	`plus(int X)` Add one matrix to another.
`static DblMatrix[]`	`polarToCartesian(DblMatrix theta, DblMatrix radius)`
`DblMatrix`	`popstd()` Calculate population standard deviation down the first dimension.
`DblMatrix`	`popStd()` Calculate the grand population standard deviation (over all elements) Calculates (SUM(X^2)-(1/N)(SUM(X))^2)/(N-1).
`static DblMatrix`	`popStd(DblMatrix X)` Calculate the grand population standard deviation (over all elements) Calculates (SUM(X^2)-(1/N)(SUM(X))^2)/(N-1).
`DblMatrix`	`popstd(int dim)` Calculate population standard deviation down the specified dimension.
`static DblMatrix`	`popVar(DblMatrix X)` Calculate the grand population variance (over all elements) Calculates (SUM(X^2)-(1/N)(SUM(X))^2)/(N-1).
`DblMatrix`	`pow(DblMatrix exponent)` Raise a Matrix to a power.
`static DblMatrix`	`pow(DblMatrix Y, DblMatrix exponent)`
`static DblMatrix`	`pow(DblMatrix Y, double exponent)`
`static DblMatrix`	`pow(DblMatrix Y, int exponent)`
`DblMatrix`	`pow(double exponent)`
`DblMatrix`	`pow(java.lang.Double exponent)`
`static DblMatrix`	`pow(double Y, DblMatrix exponent)`
`DblMatrix`	`pow(int exponent)`
`static DblMatrix`	`pow(int Y, DblMatrix exponent)`
`static DblMatrix`	`Prod(DblMatrix X)` Calculate the grand product(over all elements)
`static DblMatrix`	`prod(DblMatrix X, int dim)` Multiply along the dimension dim.
`DblMatrix`	`prod(int dim)` Returns product along the dimension dim.
`static DblMatrix`	`proj(DblMatrix u, DblMatrix v)` Orthogonally project column vector u onto column vector v.
`static DblMatrix`	`proj(DblMatrix u, DblMatrix[] v)` Orthogonally project column vector u onto the plane spanned by vectors v.
`static DblMatrix`	`radiansToDegrees(DblMatrix x)`
`static DblMatrix`	`radiansToDegrees(double x)`
`static DblMatrix`	`radiansToDegrees(int x)`
`static DblMatrix`	`random()`
`static DblMatrix`	`random(int N)`
`DblMatrix`	`reorderBy(DblMatrix indices)`
`static DblMatrix`	`replicate(DblMatrix IN, int[] multiplicity)` Replicate a matrix of arbitrary dimension along a given dimension.
`static DblMatrix`	`replicate(double input, int[] multiplicity)` Replicate a matrix of arbitrary dimension along a given dimension.
`static DblMatrix`	`replicate(int input, int[] multiplicity)` Replicate a matrix of arbitrary dimension along a given dimension.
`DblMatrix`	`reshape(int[] size)`
`static DblMatrix`	`rint(DblMatrix Y)`
`void`	`rmhighsingletons()` If an array has dimensions greater than 2 remove trailing singleton dimensions.
`static DblMatrix`	`round(DblMatrix Y)`
`boolean`	`sameSize(DblMatrix V)` Returns true if the given matrix has the same size as this matrix.
`static DblMatrix`	`scalb(DblMatrix Y, DblMatrix exponent)` Return d*2^{scalefactor} rounded as if performed by a single correctly rounded floating-point multiply to a member of the double value set.
`static DblMatrix`	`scalb(DblMatrix X, int scalefactor)` Return d*2^{scalefactor} rounded as if performed by a single correctly rounded floating-point multiply to a member of the double value set.
`static DblMatrix`	`sec(DblMatrix Y)`
`static DblMatrix`	`sech(DblMatrix Y)`
`void`	`set(java.lang.Object N, int element)` Set the pointer at the given index to a deep copy of the given Double.
`void`	`setCol(DblMatrix INPUT, DblMatrix Col)` Set a particular col.
`void`	`setCol(DblMatrix INPUT, int col)` Set a particular col.
`void`	`setDblAt(DblMatrix VALUE, int k)` Set scalar DblMatrix at a particular index.
`void`	`setDiag(DblMatrix vector)` Set main diagonal elements of a 2D matrix.
`void`	`setDiag(DblMatrix vector, int diag)` Set elements of specified diagonal of a 2D matrix.
`void`	`setDoubleAt(double VALUE, int k)` Set the Double at a particular index.
`void`	`setDoubleAt(java.lang.Double VALUE, int k)` Set the Double at a particular index.
`void`	`setDoubleAt(java.lang.Integer VALUE, int k)` Set the Double at a particular index.
`void`	`setMap(DblMatrix X, DblMatrix MAP)` Set values in a matrix based on a logical map.
`void`	`setMap(double X, DblMatrix MAP)` Set values in a matrix based on a logical map.
`void`	`setMap(java.lang.Double X, DblMatrix MAP)` Set values in a matrix based on a logical map.
`void`	`setRow(DblMatrix INPUT, DblMatrix Row)` Set a particular row.
`void`	`setRow(DblMatrix INPUT, int row)` Set a particular row.
`void`	`setSubMatrix(DblMatrix INPUT, Subscript[] subscripts)` Set a matrix of values within an existing matrix.
`void`	`setSubMatrix(int INPUT, Subscript[] subscripts)` Repeat a given value over a sub-matrix.
`void`	`show()` Display matrix on screen using default label of "matrix".
`void`	`show(java.lang.String Label)`
`void`	`show(java.lang.String Label, java.lang.String FMT)` Display matrix on screen using given label.
`static DblMatrix`	`sign(DblMatrix X)` Sign returns 1 if X is greater than 0, 0 if X equals zero and -1 if X is less than zero.
`static DblMatrix`	`sign(DblMatrix X, DblMatrix Y)` Returns sign transfer function.
`static DblMatrix`	`signum(DblMatrix Y)`
`static DblMatrix`	`signum(double Y)`
`static DblMatrix`	`signum(java.lang.Double Y)`
`static DblMatrix`	`sin(DblMatrix Y)`
`static DblMatrix`	`sinh(DblMatrix Y)`
`static DblMatrix`	`span(DblMatrix A, DblMatrix B, int N)` Create a vector that spans an upper and lower value using N steps.
`static DblMatrix`	`span(double a, double b, int N)` Create a vector that spans an upper and lower value using N steps.
`static DblMatrix`	`span(int a, int b, int N)` Create a vector that spans an upper and lower value using N steps.
`static DblMatrix[]`	`spanningSetFor(DblMatrix N)` Find a spanning set of unit vectors for the given normal vector.
`static DblMatrix`	`sqrt(DblMatrix Y)`
`static DblMatrix`	`sqrt(double Y)`
`DblMatrix`	`std()` Calculate sample standard deviation down the first dimension.
`DblMatrix`	`Std()`
`static DblMatrix`	`std(DblMatrix X)`
`static DblMatrix`	`Std(DblMatrix X)` Calculate the grand sample standard deviation (over all elements) Calculates (SUM(X^2)-(1/N)(SUM(X))^2)/(N-1).
`DblMatrix`	`std(int dim)` Calculate sample standard deviation down the specified dimension.
`int`	`subIntoIndex(int[] subindex)` Converts a single vector of subscripts into a particular index.
`static int`	`subIntoIndex(int[] subindex, int[] SIZE)` Converts a single vector of subscripts into a particular index.
`int[]`	`subscriptListToIndex(Subscript[] SUB)` Convert a Subscript[] into an array of indices assuming that the subscripts are a list of coordinates rather than a range specification.
`static int[]`	`subscriptListToIndex(Subscript[] SUB, int[] SIZE)` Convert a Subscript[] into an array of indices assuming that the subscripts are a list of coordinates rather than a range specification.
`int[]`	`subscriptToIndex(Subscript[] SUB)` Convert a Subscript[] range into an array of indices.
`static int[]`	`subscriptToIndex(Subscript[] SUB, int[] SIZE)` Convert a Subscript[] range into an array of indices.
`static DblMatrix`	`subtract(double X, DblMatrix Y)`
`static DblMatrix`	`subtract(int X, DblMatrix Y)`
`DblMatrix`	`Sum()` Calculate the grand sum (over all elements)
`static DblMatrix`	`Sum(DblMatrix X)` Calculate the grand sum (over all elements)
`static DblMatrix`	`sum(DblMatrix X, int dim)` Sum along the dimension dim.
`DblMatrix`	`sum(int dim)` Sum along the dimension dim.
`static DblMatrix`	`tan(DblMatrix Y)` Returns the trigonometric tangent of an angle.
`static DblMatrix`	`tanh(DblMatrix Y)` Returns the hyperbolic tangent of a double value.
`static boolean`	`test(DblMatrix X)` Determine if contents of DblMatrix are equal to 1.
`DblMatrix`	`times(DblMatrix X)`
`DblMatrix`	`times(double X)`
`DblMatrix`	`times(java.lang.Double X)`
`DblMatrix`	`times(int X)`
`java.lang.Double[]`	`toArray()` Returns the contents as Double[].
`static DblMatrix[]`	`toArray(DblMatrix INPUT, int dim)` Convert the input DblMatrix to an array by "slicing" along the given dimension.
`static DblMatrix`	`toDegrees(DblMatrix Y)` Converts an angle measured in radians to an approximately equivalent angle measured in degrees.
`static DblMatrix`	`toRadians(DblMatrix Y)` Converts an angle measured in degrees to an approximately equivalent angle measured in radians.
`java.lang.String`	`toString()`
`static DblMatrix`	`trace(DblMatrix X)` Return the trace of the given matrix.
`DblMatrix`	`transpose()` Transpose a 2D matrix.
`DblMatrix`	`triBwdSub(DblMatrix x)` Backward substitution using an upper triangular matrix.
`static DblMatrix`	`triBwdSub(DblMatrix R, DblMatrix x)` Backward substitution using an upper triangular matrix.
`DblMatrix`	`triFwdSub(DblMatrix y)` Solve a system of linear equations using forward-substitution.
`static DblMatrix`	`triFwdSub(DblMatrix R, DblMatrix x)` Solve a system of linear equations using forward-substitution.
`static DblMatrix`	`tril(DblMatrix X)` Get lower triangular portion of a matrix.
`static DblMatrix`	`tril(DblMatrix X, int diag)` Get lower triangular portion of a matrix.
`static DblMatrix`	`triu(DblMatrix X)` Get lower triangular portion of a matrix.
`static DblMatrix`	`triu(DblMatrix X, int diag)` Get upper triangular portion of a matrix.
`static DblMatrix`	`ulp(DblMatrix Y)`
`static DblMatrix`	`ulp(double Y)`
`static DblMatrix`	`ulp(java.lang.Double Y)`
`static DblMatrix`	`union(DblMatrix A, DblMatrix B)`
`static DblMatrix`	`unique(DblMatrix X)` Return unique elements as a DblMatrix column vector.
`void`	`updateFromDOM(org.w3c.dom.Element parentElement)`
`static DblMatrix`	`Var(DblMatrix X)` Calculate the grand sample variance (over all elements) Calculates (SUM(X^2)-(1/N)(SUM(X))^2)/(N-1).
`void`	`vec()`
`static DblMatrix`	`vec(DblMatrix Y)`
`static DblMatrix`	`vnorm(DblMatrix u)` Returns the vector norm (length) of the input vector.
`void`	`write(java.io.File datfile)` Writes matrix to a whitespace-delimited text file.
`void`	`writeIntoDOM(org.w3c.dom.Document document, org.w3c.dom.Element parentElement)`

Methods inherited from class com.mockturtlesolutions.snifflib.datatypes.GenMatrix
getN, isEmpty

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

Field Detail

Permute
```
public int[] Permute
```

IPermute
```
public int[] IPermute
```

Counter
```
public Counter Counter
```

INF
```
public static final DblMatrix INF
```

PI
```
public static final DblMatrix PI
```

E
```
public static final DblMatrix E
```

ONE
```
public static final DblMatrix ONE
```

TWO
```
public static final DblMatrix TWO
```

ZERO
```
public static final DblMatrix ZERO
```

HALF
```
public static final DblMatrix HALF
```

SQRT2
```
public static final DblMatrix SQRT2
```

NEGATIVE_INFINITY

public static final DblMatrix NEGATIVE_INFINITY

POSITIVE_INFINITY

public static final DblMatrix POSITIVE_INFINITY

NaN
```
public static final DblMatrix NaN
```

Constructor Detail

DblMatrix

public DblMatrix(MatrixSetterGetter sg)

DblMatrix
```
public DblMatrix()
```

DblMatrix

public DblMatrix(java.lang.Double[] arr,
         int[] siz)

DblMatrix
```
public DblMatrix(java.util.Vector d)
```
Creates a column vector from a Vector of Doubles.

DblMatrix

public DblMatrix(MatrixSetterGetter sg,
         int Nelements)

This construction creates an Nx1 matrix.

DblMatrix
```
public DblMatrix(int Nelements)
```

DblMatrix
```
public DblMatrix(double val)
```

DblMatrix

public DblMatrix(MatrixSetterGetter sg,
         java.lang.String inputstr)

This should be rewritten to accept a character stream.

DblMatrix

public DblMatrix(java.lang.String inputstr)

DblMatrix

public DblMatrix(MatrixSetterGetter sg,
         int[] Siz)

This construction creates a matrix of certain size.

DblMatrix
```
public DblMatrix(int[] Size)
```

DblMatrix

public DblMatrix(MatrixSetterGetter sg,
         java.lang.Integer value)

This construction creates a scalar matrix from an Integer's value.

DblMatrix
```
public DblMatrix(java.lang.Integer value)
```
This construction creates a scalar matrix from an Integer's value.

DblMatrix

public DblMatrix(MatrixSetterGetter sg,
         java.lang.Double value)

This construction creates a scalar matrix from an Double's value.

DblMatrix
```
public DblMatrix(java.lang.Double value)
```
This construction creates a scalar matrix from an Double's value.

DblMatrix

public DblMatrix(MatrixSetterGetter sg,
         DblMatrix X)

This construction creates a new DblMatrix from an input DblMatrix.

DblMatrix
```
public DblMatrix(DblMatrix X)
```
This construction creates a new DblMatrix from an input DblMatrix.

DblMatrix
```
public DblMatrix(MatrixSetterGetter sg,
         java.util.Iterator I,
         int[] Size)
```
This construction creates a new DblMatrix of dimension Size from an Iterator over Double's.

DblMatrix
```
public DblMatrix(java.util.Iterator I,
         int[] Size)
```
This construction creates a new DblMatrix of dimension Size from an Iterator over Double's.

DblMatrix
```
public DblMatrix(MatrixSetterGetter sg,
         java.util.Iterator I,
         int N)
```
This construction creates a new DblMatrix column vector from an Iterator over Double's.

DblMatrix
```
public DblMatrix(java.util.Iterator I,
         int N)
```
This construction creates a new DblMatrix column vector from an Iterator over Double's.

Method Detail

spanningSetFor
```
public static DblMatrix[] spanningSetFor(DblMatrix N)
```
Find a spanning set of unit vectors for the given normal vector. The number of vectors in the spanning set is always one less than the length of n. The spanning set returned is oriented in the "right-handed" direction.

orth
```
public static DblMatrix orth(DblMatrix u)
```
Return a vector orthogonal to the given vector.

orth
```
public static DblMatrix orth(DblMatrix[] u)
```
Return a vector orthogonal to the spanning set of vectors.

GramSchmidt

public static DblMatrix[] GramSchmidt(DblMatrix[] u)

comp
```
public static DblMatrix comp(DblMatrix u,
             DblMatrix v)
```
Return the scalar projection (or component) of u onto v. Note that the orthogonal projection of u onto v is comp(u,v)*v/|v|.

vnorm
```
public static DblMatrix vnorm(DblMatrix u)
```
Returns the vector norm (length) of the input vector.

gap

public static DblMatrix gap(DblMatrix u,
            DblMatrix v)

Returns the cosine of the angle between the two input vectors.

proj
```
public static DblMatrix proj(DblMatrix u,
             DblMatrix[] v)
```
Orthogonally project column vector u onto the plane spanned by vectors v. v must be an orthogongal basis such as the kind produced by Gram-Schmidt.

proj

public static DblMatrix proj(DblMatrix u,
             DblMatrix v)

Orthogonally project column vector u onto column vector v.

convertStringToDbl

public static DblMatrix convertStringToDbl(java.lang.String in)

convertDblToString

public static java.lang.String convertDblToString(DblMatrix in)

getPersistenceDelegate

public static java.beans.PersistenceDelegate getPersistenceDelegate()

toString
```
public java.lang.String toString()
```
Overrides:

toString in class java.lang.Object

writeIntoDOM

public void writeIntoDOM(org.w3c.dom.Document document,
                org.w3c.dom.Element parentElement)

Specified by:: writeIntoDOM in interface DOMUpdateable

updateFromDOM
```
public void updateFromDOM(org.w3c.dom.Element parentElement)
```
Specified by:

updateFromDOM in interface DOMUpdateable

cumProd
```
public DblMatrix cumProd(int dim)
```
Calculate the cummulative product down the given dimension.

cumSum
```
public DblMatrix cumSum(int dim)
```
Calculate the cummulative sum down the given dimension.

getDoubleAt
```
public java.lang.Double getDoubleAt(int k)
```
Return the Double at a particular index.

getDblAt
```
public DblMatrix getDblAt(int k)
```
Return the scalar DblMatrix at a particular index.

setDblAt

public void setDblAt(DblMatrix VALUE,
            int k)

Set scalar DblMatrix at a particular index.

setDoubleAt

public void setDoubleAt(java.lang.Double VALUE,
               int k)

Set the Double at a particular index.

setDoubleAt

public void setDoubleAt(java.lang.Integer VALUE,
               int k)

Set the Double at a particular index.

setDoubleAt

public void setDoubleAt(double VALUE,
               int k)

Set the Double at a particular index.

getNextRow

public static DblMatrix getNextRow(java.io.StreamTokenizer STT)
                            throws SnifflibDatatypeException

Throws:: SnifflibDatatypeException

concat

public DblMatrix concat(DblMatrix B,
               int dim)

cccopy
```
protected DblMatrix cccopy()
```
Copy using the current counter configuration. This is protected since probably has no use outside the class.

copy
```
public DblMatrix copy()
```
Make a deep copy of the matrix.

getSize
```
public int getSize(int dim)
```

get

public java.lang.Object get(int element)

isScalar

public static DblMatrix isScalar(DblMatrix X)

Determine if a matrix is sized 1x1.

find

public static DblMatrix find(DblMatrix X)

test
```
public static boolean test(DblMatrix X)
```
Determine if contents of DblMatrix are equal to 1. The return value is true if contents are 1 and false otherwise.

or

public static DblMatrix or(DblMatrix Z,
           DblMatrix X)

"Or" one matrix with another.

or

public static DblMatrix or(int X,
           DblMatrix Z)

"Or" one matrix with another.

or

public static DblMatrix or(double X,
           DblMatrix Z)

"Or" one matrix with another.

or

public static DblMatrix or(DblMatrix Z,
           int X)

"Or" one matrix with another.

or
```
public DblMatrix or(DblMatrix Z)
```
"Or" one matrix with another.

or

public static DblMatrix or(DblMatrix Z,
           double X)

"Or" one matrix with another.