1.5.1

ndarray-simd/com.martmists.ndarray.simd/F64TwoAxisArray

F64TwoAxisArray

interface F64TwoAxisArray : F64Array

A 2D specialization type for F64Array.

Since

1.2.0

Types

object Companion

Properties

abstract val data: DoubleArray

The underlying data of the array. This should not typically be accessed directly.

val F64Array.image: F64ImageArray

A wrapper for image operations. The receiver array must have shape [width, height, channels] where channels is 3 or 4.

abstract val isFlattenable: Boolean

Whether the array can be flattened.

open val length: Int

The length of the array in the first dimension.

open val nDim: Int

The number of dimensions of the array.

abstract val offset: Int

The offset into the data array where the array starts.

abstract val shape: IntArray

The shape of the array.

abstract val strides: IntArray

The strides of the array.

abstract val unrollDim: Int

The unrolling dimension of the array.

abstract val unrollSize: Int

The size of the unrolling dimension.

abstract val unrollStride: Int

The stride of the unrolling dimension.

abstract val V: Viewer

Returns an indexable viewer for the array to avoid chaining view calls.

Functions

open override fun abs(): F64TwoAxisArray

open fun absInPlace()

Computes the absolute value of each element in the array in place.

open override fun acos(): F64TwoAxisArray

open override fun acosh(): F64TwoAxisArray

open fun acoshInPlace()

Computes the hyperbolic arccosine of each element in the array in place.

open fun acosInPlace()

Computes the arccosine of each element in the array in place.

open fun along(axis: Int): Sequence<F64Array>

Iterates over the array along the specified axis.

open infix override fun and(other: F64Array): F64TwoAxisArray

open infix override fun and(other: Int): F64TwoAxisArray

open fun andInPlace(other: F64Array)

Computes the bitwise and of each element in the array with another array in place. The values are first cast to integers before the operation.

open fun andInPlace(other: Int)

Computes the bitwise and of each element in the array with a scalar in place. The values are first cast to integers before the operation.

open override fun asin(): F64TwoAxisArray

open override fun asinh(): F64TwoAxisArray

open fun asinhInPlace()

Computes the hyperbolic arcsine of each element in the array in place.

open fun asinInPlace()

Computes the arcsine of each element in the array in place.

open override fun atan(): F64TwoAxisArray

open override fun atan2(other: F64Array): F64TwoAxisArray

open fun atan2InPlace(other: F64Array)

Computes the 2nd-argument arctangent of each element in the array in place.

open override fun atanh(): F64TwoAxisArray

open fun atanhInPlace()

Computes the hyperbolic arctangent of each element in the array in place.

open fun atanInPlace()

Computes the arctangent of each element in the array in place.

open fun ceil(): F64Array

Computes the ceiling of each element in the array.

open fun ceilInPlace()

Computes the ceiling of each element in the array in place.

inline fun F64Array.checkAxis(axis: Int)

Checks if the axis is valid.

open fun checkShape(other: F64Array): F64Array

Checks if the shape of the array matches the shape of another array.

open override fun coerce(min: Double, max: Double): F64TwoAxisArray

open fun coerceInPlace(min: Double, max: Double)

Coerces the array to the specified range in place.

abstract operator fun contains(other: Double): Boolean

Checks if the array contains the specified value.

convertHSVtoRGB

fun F64Array.~~convertHSVtoRGB~~(): F64ImageArray

Converts an HSV(A) image to RGB(A)

convertRGBtoHSV

fun F64Array.~~convertRGBtoHSV~~(): F64ImageArray

Converts an RGB(A) image to HSV(A)

open override fun copy(): F64TwoAxisArray

open fun copyTo(other: F64Array)

Copies the array to another array.

open override fun cos(): F64TwoAxisArray

open override fun cosh(): F64TwoAxisArray

open fun coshInPlace()

Computes the hyperbolic cosine of each element in the array in place.

open fun cosInPlace()

Computes the cosine of each element in the array in place.

open override fun cumSum(): F64TwoAxisArray

open fun cumSumInPlace()

Calculates the cumulative sum of the array in place.

abstract fun determinant(): Double

Returns the determination of this matrix.

abstract fun diagonal(): F64FlatArray

Returns the diagonal of the array.

open operator override fun div(other: F64Array): F64TwoAxisArray

open operator override fun div(other: Double): F64TwoAxisArray

open operator fun divAssign(other: F64Array)

Divides this array by another array in place.

open operator fun divAssign(other: Double)

Divides each element in the array by a scalar in place.

abstract fun eigen(): Pair<F64FlatArray, F64TwoAxisArray>

Calculates the eigenvalues and eigenvectors of this F64TwoAxisArray using the QR algorithm.

open infix override fun eq(other: F64Array): F64TwoAxisArray

open infix override fun eq(other: Double): F64TwoAxisArray

open fun eqInPlace(other: F64Array)

Compares if each element in the array is equal to another array in place.

open fun eqInPlace(other: Double)

Compares if each element in the array is equal to a scalar in place.

open override fun exp(): F64TwoAxisArray

open override fun expBase(base: Double): F64TwoAxisArray

open fun expBaseInPlace(base: Double)

Computes base^x for each element in the array in place.

open fun expInPlace()

Computes e^x for each element in the array in place.

open override fun expm1(): F64TwoAxisArray

open fun expm1InPlace()

Computes e^x - 1 for each element in the array in place.

open fun fftC2C(): F64TwoAxisArray

Performs a Complex-to-Complex FFT on this array. The second axis has to be real, imag. The resulting array is not normalized.

abstract fun fftC2CInPlace()

Performs a Complex-to-Complex FFT on this array in-place. The second axis has to be real, imag. The resulting array is not normalized.

open fun fill(value: Double)

Fills the array with the specified value.

open fun flatten(): F64FlatArray

Flattens the array to a 1D array.

open fun floor(): F64Array

Computes the floor of each element in the array.

open fun floorInPlace()

Computes the floor of each element in the array in place.

abstract fun <T> fold(initial: T, operation: (acc: T, Double) -> T): T

Folds the array with an initial value and an operation.

abstract operator fun get(vararg indices: Int): Double

Indexing operators

abstract operator fun get(r: Int, c: Int): Double

abstract operator fun get(d: Int, r: Int, c: Int): Double

open infix override fun gt(other: F64Array): F64TwoAxisArray

open infix override fun gt(other: Double): F64TwoAxisArray

open infix override fun gte(other: F64Array): F64TwoAxisArray

open infix override fun gte(other: Double): F64TwoAxisArray

open fun gteInPlace(other: F64Array)

Compares if each element in the array is greater than or equal to another array in place.

open fun gteInPlace(other: Double)

Compares if each element in the array is greater than or equal to a scalar in place.

open fun gtInPlace(other: F64Array)

Compares if each element in the array is greater than another array in place.

open fun gtInPlace(other: Double)

Compares if each element in the array is greater than a scalar in place.

open override fun hypot(other: F64Array): F64TwoAxisArray

open fun hypotInPlace(other: F64Array)

Computes the hypothenuse of each element in the array with another array in place.

open fun ifftC2C(): F64TwoAxisArray

Performs an inverse Complex-to-Complex FFT on this array. The second axis has to be real, imag. The resulting array is not normalized.

open fun ifftC2CInPlace()

Performs an inverse Complex-to-Complex FFT on this array in-place. The second axis has to be real, imag. The resulting array is not normalized.

abstract fun inverse(): F64TwoAxisArray

Returns the inverse matrix. Note: for MxN matrices, it assumes a full-rank matrix.

open fun isFinite(): F64Array

Compares if each element in the array is finite.

isFiniteInPlace

open fun isFiniteInPlace()

Compares if each element in the array is finite in place.

open fun isInf(): F64Array

Compares if each element in the array is infinite.

open fun isInfInPlace()

Compares if each element in the array is infinite in place.

open fun isNan(): F64Array

Compares if each element in the array is NaN.

open fun isNanInPlace()

Compares if each element in the array is NaN in place.

open fun ln(): F64Array

open fun lnInPlace()

open override fun log(): F64TwoAxisArray

open override fun log10(): F64TwoAxisArray

open fun log10InPlace()

Computes log10(x) for each element in the array in place.

open override fun log1p(): F64TwoAxisArray

open fun log1pInPlace()

Computes ln(1 + x) for each element in the array in place.

open override fun log2(): F64TwoAxisArray

open fun log2InPlace()

Computes log2(x) for each element in the array in place.

open override fun logBase(base: Double): F64TwoAxisArray

open fun logBaseInPlace(base: Double)

Computes log(x) / log(base) for each element in the array in place.

open fun logInPlace()

Computes ln(x) for each element in the array in place.

open infix override fun lt(other: F64Array): F64TwoAxisArray

open infix override fun lt(other: Double): F64TwoAxisArray

open infix override fun lte(other: F64Array): F64TwoAxisArray

open infix override fun lte(other: Double): F64TwoAxisArray

open fun lteInPlace(other: F64Array)

Compares if each element in the array is less than or equal to another array in place.

open fun lteInPlace(other: Double)

Compares if each element in the array is less than or equal to a scalar in place.

open fun ltInPlace(other: F64Array)

Compares if each element in the array is less than another array in place.

open fun ltInPlace(other: Double)

Compares if each element in the array is less than a scalar in place.

abstract infix fun matmul(other: F64TwoAxisArray): F64TwoAxisArray

Computes the matrix multiplication of this array with another array. This requires this.shape[1] == other.shape[0]

open fun max(): Double

Returns the maximum element in the array.

open fun mean(): Double

Returns the mean of all elements in the array.

open fun min(): Double

Returns the minimum element in the array.

open operator override fun minus(other: F64Array): F64TwoAxisArray

open operator override fun minus(other: Double): F64TwoAxisArray

open operator fun minusAssign(other: F64Array)

Subtracts another array from this array in place.

open operator fun minusAssign(other: Double)

Subtracts a scalar from each element in the array in place.

open infix override fun neq(other: F64Array): F64TwoAxisArray

open infix override fun neq(other: Double): F64TwoAxisArray

open fun neqInPlace(other: F64Array)

Compares if each element in the array is not equal to another array in place.

open fun neqInPlace(other: Double)

Compares if each element in the array is not equal to a scalar in place.

open override fun not(): F64TwoAxisArray

open fun notInPlace()

Computes the bitwise not of each element in the array in place. The values are first cast to integers before the operation.

open infix override fun or(other: F64Array): F64TwoAxisArray

open infix override fun or(other: Int): F64TwoAxisArray

open fun orInPlace(other: F64Array)

Computes the bitwise or of each element in the array with another array in place. The values are first cast to integers before the operation.

open fun orInPlace(other: Int)

Computes the bitwise or of each element in the array with a scalar in place. The values are first cast to integers before the operation.

open operator override fun plus(other: F64Array): F64TwoAxisArray

open operator override fun plus(other: Double): F64TwoAxisArray

open operator fun plusAssign(other: F64Array)

Adds another array to this array in place.

open operator fun plusAssign(other: Double)

Adds a scalar to each element in the array in place.

open override fun pow(power: Double): F64TwoAxisArray

open fun powInPlace(power: Double)

Computes x^power for each element in the array in place.

open fun product(): Double

Returns the product of all elements in the array.

abstract fun reduce(operation: (Double, Double) -> Double): Double

Reduces the array with an operation.

abstract fun reduce(axis: Int, operation: (Double, Double) -> Double): F64Array

Reduces the array with an operation along the given axis.

open operator override fun rem(other: F64Array): F64TwoAxisArray

open operator override fun rem(other: Double): F64TwoAxisArray

open operator fun remAssign(other: F64Array)

Divides this array by another array in plac and takes the remainder.

open operator fun remAssign(other: Double)

Divides each element with a scalar and takes the remainder.

open fun reorder(indices: IntArray, axis: Int = 0)

Reorders the array along the specified axis.

open fun reshape(vararg shape: Int): F64Array

open fun reshape(rows: Int, cols: Int): F64TwoAxisArray

Reshapes the array to the specified shape.

open fun round(): F64Array

Rounds each element in the array.

open fun roundInPlace()

Rounds each element in the array in place.

abstract fun scan(operation: (Double, Double) -> Double)

Scans the array in-place with an operation. Scan is like reduce, but it saves the intermediate values. For example, cumsum might be implemented as scan(Double::plus)

abstract fun scan(axis: Int, operation: (Double, Double) -> Double)

Scans the array in-place with an operation along the given axis.

abstract operator fun set(vararg indices: Int, value: Double)

abstract operator fun set(r: Int, c: Int, value: Double)

abstract operator fun set(d: Int, r: Int, c: Int, value: Double)

open infix override fun shl(other: F64Array): F64TwoAxisArray

open infix override fun shl(other: Int): F64TwoAxisArray

open fun shlInPlace(other: F64Array)

Shifts each element in the array to the left by the elements in another array in place. The values of both arrays are first cast to integers before the operation.

open fun shlInPlace(other: Int)

Shifts each element in the array to the left by a scalar in place. The values are first cast to integers before the operation.

open infix override fun shr(other: F64Array): F64TwoAxisArray

open infix override fun shr(other: Int): F64TwoAxisArray

open fun shrInPlace(other: F64Array)

Shifts each element in the array to the right by the elements in another array in place. The values of both arrays are first cast to integers before the operation.

open fun shrInPlace(other: Int)

Shifts each element in the array to the right by a scalar in place. The values are first cast to integers before the operation.

open override fun sin(): F64TwoAxisArray

open override fun sinh(): F64TwoAxisArray

open fun sinhInPlace()

Computes the hyperbolic sine of each element in the array in place.

open fun sinInPlace()

Computes the sine of each element in the array in place.

abstract override fun slice(from: Int, to: Int, step: Int, axis: Int): F64TwoAxisArray

open override fun sqrt(): F64TwoAxisArray

open fun sqrtInPlace()

Computes the square root of each element in the array in place.

open fun stdDev(): Double

Returns the standard deviation of all elements in the array.

open fun sum(): Double

Returns the sum of all elements in the array.

open override fun tan(): F64TwoAxisArray

open override fun tanh(): F64TwoAxisArray

open fun tanhInPlace()

Computes the hyperbolic tangent of each element in the array in place.

open fun tanInPlace()

Computes the tangent of each element in the array in place.

open operator override fun times(other: F64Array): F64TwoAxisArray

open operator override fun times(other: Double): F64TwoAxisArray

open operator fun timesAssign(other: F64Array)

Multiplies another array with this array in place. This is element-wise multiplication, not matrix multiplication.

open operator fun timesAssign(other: Double)

Multiplies each element in the array with a scalar in place.

fun F64Array.toCSV(separator: String = ","): Sequence<String>

Writes an F64Array to a CSV string.

fun F64Array.toCSV(csv: <Error class: unknown class>, separator: String = ",")

Writes an F64Array to a CSV file.

open fun toDoubleArray(): DoubleArray

Returns the data from the array as a flat array.

fun F64Array.toFloatArray(): FloatArray

Converts an F64Array to a FloatArray. Only supported on flat arrays.

fun F64Array.~~toImage~~(file: <Error class: unknown class>)

Writes an F64Array to an image file.

fun F64Array.~~toOpenCVMat~~(type: Int = CvType.CV_64FC4): <Error class: unknown class>

Converts an F64Array to a Mat.

open fun toString(maxDisplay: Int): String

open override fun transform(transform: (Double) -> Double): F64TwoAxisArray

transformInPlace

abstract fun transformInPlace(transform: (Double) -> Double)

Transforms the array in place.

abstract override fun transpose(ax1: Int, ax2: Int): F64TwoAxisArray

open fun trunc(): F64Array

Truncates each element in the array.

open fun truncInPlace()

Truncates each element in the array in place.

open operator override fun unaryMinus(): F64TwoAxisArray

unaryMinusInPlace

open fun unaryMinusInPlace()

Negates each element in the array in place.

open operator override fun unaryPlus(): F64TwoAxisArray

open fun variance(): Double

Returns the variance of all elements in the array.

open fun view(index: Int, axis: Int = 0): F64Array

Returns a view of the array along the specified axis.

open infix override fun xor(other: F64Array): F64TwoAxisArray

open infix override fun xor(other: Int): F64TwoAxisArray

open fun xorInPlace(other: F64Array)

Computes the bitwise xor of each element in the array with another array in place. The values are first cast to integers before the operation.

open fun xorInPlace(other: Int)

Computes the bitwise xor of each element in the array with a scalar in place. The values are first cast to integers before the operation.

open override fun zipTransform(other: F64Array, transform: (Double, Double) -> Double): F64TwoAxisArray

zipTransformInPlace

abstract fun zipTransformInPlace(other: F64Array, transform: (Double, Double) -> Double)

Zips the array with another array and transforms it in place.