|
CDMA plugin API
3.1.0
CDMA core library
|
The IArrayMath interface defines some commons math operations on a IArray. More...
Public Member Functions | |
| IArray | getArray () |
| IArrayMath | toAdd (IArray array) throws ShapeNotMatchException |
| IArrayMath | toAdd (IArrayMath array) throws ShapeNotMatchException |
| IArrayMath | add (IArray array) throws ShapeNotMatchException |
| IArrayMath | add (IArrayMath array) throws ShapeNotMatchException |
| IArrayMath | toAdd (double value) |
| IArrayMath | add (double value) |
| IArrayMath | toEltMultiply (IArray array) throws ShapeNotMatchException |
| IArrayMath | toEltMultiply (IArrayMath array) throws ShapeNotMatchException |
| IArrayMath | eltMultiply (IArray array) throws ShapeNotMatchException |
| IArrayMath | eltMultiply (IArrayMath array) throws ShapeNotMatchException |
| IArrayMath | toScale (double value) |
| IArrayMath | scale (double value) |
| IArrayMath | matMultiply (IArray array) throws ShapeNotMatchException |
| IArrayMath | matMultiply (IArrayMath array) throws ShapeNotMatchException |
| IArrayMath | matInverse () throws ShapeNotMatchException |
| IArrayMath | toSqrt () |
| IArrayMath | sqrt () |
| IArrayMath | toExp () |
| IArrayMath | exp () |
| IArrayMath | toLn () |
| IArrayMath | ln () |
| IArrayMath | toLog10 () |
| IArrayMath | log10 () |
| IArrayMath | toSin () |
| IArrayMath | sin () |
| IArrayMath | toAsin () |
| IArrayMath | asin () |
| IArrayMath | toCos () |
| IArrayMath | toAcos () |
| IArrayMath | cos () |
| IArrayMath | acos () |
| IArrayMath | toTan () |
| IArrayMath | tan () |
| IArrayMath | toAtan () |
| IArrayMath | atan () |
| IArrayMath | toPower (double power) |
| IArrayMath | power (double power) |
| double | powerSum (IArray axis, int dimension, double power) throws ShapeNotMatchException |
| double | powerSum (IArrayMath axis, int dimension, double power) throws ShapeNotMatchException |
| double | sum () |
| double | sumNormalise () |
| IArrayMath | toEltInverse () throws DivideByZeroException |
| IArrayMath | eltInverse () throws DivideByZeroException |
| IArrayMath | toEltInverseSkipZero () |
| IArrayMath | eltInverseSkipZero () |
| double | vecDot (IArray array) throws ShapeNotMatchException |
| double | vecDot (IArrayMath array) throws ShapeNotMatchException |
| IArrayMath | sumForDimension (int dimension, boolean isVariance) throws ShapeNotMatchException |
| double | varianceSumNormalise () |
| IArrayMath | enclosedSumForDimension (int dimension, boolean isVariance) throws ShapeNotMatchException |
| double | getNorm () |
| IArrayMath | normalise () |
| void | eltMultiplyWithEqualSize (IArray array, IArray result) throws ShapeNotMatchException |
| void | eltMultiplyWithEqualSize (IArrayMath array, IArrayMath result) throws ShapeNotMatchException |
| void | eltDivideWithEqualSize (IArray array, IArray result) throws ShapeNotMatchException |
| void | eltDivideWithEqualSize (IArrayMath array, IArrayMath result) throws ShapeNotMatchException |
| IArrayMath | toEltDivide (IArray array) throws ShapeNotMatchException |
| IArrayMath | toEltDivide (IArrayMath array) throws ShapeNotMatchException |
| IArrayMath | eltDivide (IArray array) throws ShapeNotMatchException |
| IArrayMath | eltDivide (IArrayMath array) throws ShapeNotMatchException |
| IArrayMath | eltRemainder (final IArray newArray) throws ShapeNotMatchException |
| IArrayMath | eltRemainder (IArrayMath array) throws ShapeNotMatchException |
| IArrayMath | toEltRemainder (final IArray newArray) throws ShapeNotMatchException |
| IArrayMath | toEltRemainder (IArrayMath array) throws ShapeNotMatchException |
| void | eltRemainderEqualSize (IArrayMath array, IArrayMath result) throws ShapeNotMatchException |
| void | eltRemainderEqualSize (final IArray newArray, final IArray result) throws ShapeNotMatchException |
| IArrayMath | toMod (final double value) |
| IArrayMath | mod (final double value) |
| double | getDeterminant () throws ShapeNotMatchException |
| double | getMaximum () |
| double | getMinimum () |
| IFactory | getFactory () |
The IArrayMath interface defines some commons math operations on a IArray.
pluginAPI It is used to provide some commons math method that are often used on array.
Update the array with arc cosine of its values.
| IArrayMath org.gumtree.data.math.IArrayMath.add | ( | IArray | array | ) | throws ShapeNotMatchException |
Update the array with element-wise add values from another array to its values.
| array | IArray object |
| ShapeNotMatchException | mismatching shape |
| IArrayMath org.gumtree.data.math.IArrayMath.add | ( | double | value | ) |
Update the array with adding a constant to its values.
| value | double type |
Update the array with arc sine of its values.
Update the array with arc trigonometric of its values.
Update the array with cosine of its values.
Element wise divide the value by value from a given array.
| array | IArray object |
| ShapeNotMatchException | mismatching shape |
| IArrayMath org.gumtree.data.math.IArrayMath.eltDivide | ( | IArrayMath | array | ) | throws ShapeNotMatchException |
| void org.gumtree.data.math.IArrayMath.eltDivideWithEqualSize | ( | IArray | array, |
| IArray | result | ||
| ) | throws ShapeNotMatchException |
Element-wise divided by another array, and put the result in a given array.
| array | CDMA IArray object |
| result | CDMA IArray object |
| ShapeNotMatchException |
| void org.gumtree.data.math.IArrayMath.eltDivideWithEqualSize | ( | IArrayMath | array, |
| IArrayMath | result | ||
| ) | throws ShapeNotMatchException |
Update the array with element-wise inverse of its values.
| DivideByZeroException | divided by zero |
Update the array with element-wise inverse of its values, skip zero values.
| IArrayMath org.gumtree.data.math.IArrayMath.eltMultiply | ( | IArray | array | ) | throws ShapeNotMatchException |
Update the array with the element wise multiply of its values.
| array | IArray object |
| ShapeNotMatchException | mismatching shape |
| IArrayMath org.gumtree.data.math.IArrayMath.eltMultiply | ( | IArrayMath | array | ) | throws ShapeNotMatchException |
| void org.gumtree.data.math.IArrayMath.eltMultiplyWithEqualSize | ( | IArray | array, |
| IArray | result | ||
| ) | throws ShapeNotMatchException |
Element-wise multiply another array, and put the result in a given array.
| array | CDMA IArray object |
| result | CDMA IArray object |
| ShapeNotMatchException |
| void org.gumtree.data.math.IArrayMath.eltMultiplyWithEqualSize | ( | IArrayMath | array, |
| IArrayMath | result | ||
| ) | throws ShapeNotMatchException |
| IArrayMath org.gumtree.data.math.IArrayMath.eltRemainder | ( | final IArray | newArray | ) | throws ShapeNotMatchException |
| IArrayMath org.gumtree.data.math.IArrayMath.eltRemainder | ( | IArrayMath | array | ) | throws ShapeNotMatchException |
| void org.gumtree.data.math.IArrayMath.eltRemainderEqualSize | ( | IArrayMath | array, |
| IArrayMath | result | ||
| ) | throws ShapeNotMatchException |
| void org.gumtree.data.math.IArrayMath.eltRemainderEqualSize | ( | final IArray | newArray, |
| final IArray | result | ||
| ) | throws ShapeNotMatchException |
| IArrayMath org.gumtree.data.math.IArrayMath.enclosedSumForDimension | ( | int | dimension, |
| boolean | isVariance | ||
| ) | throws ShapeNotMatchException |
Do sum calculation for every slice of the array on a dimension. The result will be a one dimensional IArray.
| dimension | integer value |
| isVariance | true if the array serves as variance |
| ShapeNotMatchException |
Update the array with e raised to the power of its values.
| double org.gumtree.data.math.IArrayMath.getDeterminant | ( | ) | throws ShapeNotMatchException |
Calculate the determinant value.
| array | in array type |
| ShapeNotMatchException | shape not match |
| IFactory org.gumtree.data.math.IArrayMath.getFactory | ( | ) |
Get the appropriate facgtory for this math object.
| double org.gumtree.data.math.IArrayMath.getMaximum | ( | ) |
Get maximum value of the array as a double type if it is a numeric array.
| array | in array type |
| double org.gumtree.data.math.IArrayMath.getMinimum | ( | ) |
Get minimum value of the array as a double type if it is a numeric array.
| array | in array type |
| double org.gumtree.data.math.IArrayMath.getNorm | ( | ) |
Get the L2 norm of the IArray. The array must have only one dimension.
Update the array with element-wise natural logarithm of its values.
Update the array with element-wise logarithm (base 10) of its values.
Inverse the array assume it's a matrix.
| array | in array type |
| ShapeNotMatchException |
| IArrayMath org.gumtree.data.math.IArrayMath.matMultiply | ( | IArray | array | ) | throws ShapeNotMatchException |
Multiple two arrays in matrix multiplication rule. The two arrays must comply matrix multiply requirement.
| array | in IArray type |
| ShapeNotMatchException |
| IArrayMath org.gumtree.data.math.IArrayMath.matMultiply | ( | IArrayMath | array | ) | throws ShapeNotMatchException |
| IArrayMath org.gumtree.data.math.IArrayMath.mod | ( | final double | value | ) |
Normalise the vector to norm = 1.
| IArrayMath org.gumtree.data.math.IArrayMath.power | ( | double | power | ) |
Update the array with to a constant power of its values.
| power | double value |
| double org.gumtree.data.math.IArrayMath.powerSum | ( | IArray | axis, |
| int | dimension, | ||
| double | power | ||
| ) | throws ShapeNotMatchException |
Do a power-sum on a certain dimension. A power-sum will raise all element of the array to a certain power, then do a sum on a certain dimension, and put weight on the result.
| axis | IArray object |
| dimension | integer |
| power | double value |
| ShapeNotMatchException |
| double org.gumtree.data.math.IArrayMath.powerSum | ( | IArrayMath | axis, |
| int | dimension, | ||
| double | power | ||
| ) | throws ShapeNotMatchException |
| IArrayMath org.gumtree.data.math.IArrayMath.scale | ( | double | value | ) |
Update the array with the scale of its values.
| value | double type |
Update the array with sine of its values.
Update the array with of the square root its value.
| double org.gumtree.data.math.IArrayMath.sum | ( | ) |
Calculate the sum value of the array. If an element is NaN, skip it.
| IArrayMath org.gumtree.data.math.IArrayMath.sumForDimension | ( | int | dimension, |
| boolean | isVariance | ||
| ) | throws ShapeNotMatchException |
Do sum calculation for every slice of the array on a dimension. The result will be a one dimensional IArray.
| dimension | integer value |
| isVariance | true if the array serves as variance |
| ShapeNotMatchException |
Calculate the sum value of the array. If an element is NaN, skip it. Then after calculation, normalise the result to the actual size of the array. For example, result = raw sum * size of array / (size of array - number of NaNs).
Update the array with trigonometric of its values.
Calculate the arc cosine value of each elements in the IArray.
| IArrayMath org.gumtree.data.math.IArrayMath.toAdd | ( | IArray | array | ) | throws ShapeNotMatchException |
Add two IArray together, element-wisely. The two arrays must have the same shape.
| array | in IArray type |
| ShapeNotMatchException | mismatching shape |
| IArrayMath org.gumtree.data.math.IArrayMath.toAdd | ( | double | value | ) |
Add a value to the IArray element-wisely.
| value | double type |
Calculate the arc sine value of each elements in the IArray.
Calculate the arc trigonometric value of each elements in the IArray.
Calculate the cosine value of each elements in the IArray.
| IArrayMath org.gumtree.data.math.IArrayMath.toEltDivide | ( | IArray | array | ) | throws ShapeNotMatchException |
Element wise divide the value by value from a given array.
| array | IArray object |
| ShapeNotMatchException | mismatching shape |
| IArrayMath org.gumtree.data.math.IArrayMath.toEltDivide | ( | IArrayMath | array | ) | throws ShapeNotMatchException |
Inverse every element of the array into a new storage.
| DivideByZeroException |
Do a element-wise inverse calculation that skip zero values. Yij = 1 / Xij.
| IArrayMath org.gumtree.data.math.IArrayMath.toEltMultiply | ( | IArray | array | ) | throws ShapeNotMatchException |
Multiply the two arrays element-wisely. Xij = Aij * Bij. The two arrays must have the same shape.
| array | in IArray type |
| ShapeNotMatchException | mismatching shape |
| IArrayMath org.gumtree.data.math.IArrayMath.toEltMultiply | ( | IArrayMath | array | ) | throws ShapeNotMatchException |
| IArrayMath org.gumtree.data.math.IArrayMath.toEltRemainder | ( | final IArray | newArray | ) | throws ShapeNotMatchException |
| IArrayMath org.gumtree.data.math.IArrayMath.toEltRemainder | ( | IArrayMath | array | ) | throws ShapeNotMatchException |
Calculate the e raised to the power of double values in the IArray element-wisely.
Calculate an element-wise natural logarithm of values of an IArray.
Calculate an element-wise logarithm (base 10) of values of an IArray.
| IArrayMath org.gumtree.data.math.IArrayMath.toMod | ( | final double | value | ) |
| IArrayMath org.gumtree.data.math.IArrayMath.toPower | ( | double | power | ) |
Do an element-wise power calculation of the array. Yij = Xij ^ power.
| power | double value |
| IArrayMath org.gumtree.data.math.IArrayMath.toScale | ( | double | value | ) |
Scale the array with a double value.
| value | double type |
Calculate the sine value of each elements in the IArray.
Calculate the square root value of every element of the array.
Calculate the trigonometric value of each elements in the IArray.
Treat the array as a variance. Normalise the sum against the number of elements in the array.
| double org.gumtree.data.math.IArrayMath.vecDot | ( | IArray | array | ) | throws ShapeNotMatchException |
Calculate the vector dot production of two arrays. Both array must have the same size.
| array | in IArray type |
| ShapeNotMatchException |
| double org.gumtree.data.math.IArrayMath.vecDot | ( | IArrayMath | array | ) | throws ShapeNotMatchException |