kmath-complex/space.kscience.kmath.complex

Package-level declarations

Types

data class Complex(val re: Double, val im: Double)

Represents double-based complex number.

object ComplexField : ExtendedField<Complex> , Norm<Complex, Complex> , NumbersAddOps<Complex> , ScaleOperations<Complex>

A field of Complex.

ComplexFieldND

class ComplexFieldND(val shape: ShapeND) : ComplexFieldOpsND, FieldND<Complex, ComplexField> , NumbersAddOps<StructureND<Complex>>

ComplexFieldOpsND

sealed class ComplexFieldOpsND : BufferedFieldOpsND<Complex, ComplexField> , ScaleOperations<StructureND<Complex>> , ExtendedFieldOps<StructureND<Complex>> , PowerOperations<StructureND<Complex>>

An optimized nd-field for complex numbers

Quaternion

class Quaternion(val w: Double, val x: Double, val y: Double, val z: Double) : Buffer<Double>

Represents double-based quaternion.

QuaternionField

object QuaternionField : Field<Quaternion> , Norm<Quaternion, Double> , PowerOperations<Quaternion> , ExponentialOperations<Quaternion> , NumbersAddOps<Quaternion> , ScaleOperations<Quaternion>

A field of Quaternion.

Functions

complex

inline fun Buffer.Companion.complex(size: Int, init: (Int) -> Complex): Buffer<Complex>

inline fun MutableBuffer.Companion.complex(size: Int, init: (Int) -> Complex): MutableBuffer<Complex>

Creates a new buffer of complex numbers with the specified size, where each element is calculated by calling the specified init function.

ndAlgebra

fun ComplexField.ndAlgebra(vararg shape: Int): ComplexFieldND

normalized

fun Quaternion.normalized(): Quaternion

Produce a normalized version of this quaternion

Quaternion

fun Quaternion(w: Number, x: Number = 0.0, y: Number = 0.0, z: Number = 0.0): Quaternion

quaternion

inline fun Buffer.Companion.quaternion(size: Int, init: (Int) -> Quaternion): Buffer<Quaternion>

inline fun MutableBuffer.Companion.quaternion(size: Int, init: (Int) -> Quaternion): MutableBuffer<Quaternion>

Creates a new buffer of quaternions with the specified size, where each element is calculated by calling the specified init function.

toComplex

fun Number.toComplex(): Complex

Creates a complex number with real part equal to this real.

withNdAlgebra

inline fun <R> ComplexField.withNdAlgebra(vararg shape: Int, action: ComplexFieldND.() -> R): R

Produce a context for n-dimensional operations inside this real field

Properties

algebra

val Complex.Companion.algebra: ComplexField

conjugate

val Complex.conjugate: Complex

This complex's conjugate.

val Quaternion.conjugate: Quaternion

This quaternion's conjugate.

ndAlgebra

val ComplexField.ndAlgebra: ComplexFieldOpsND

val Complex.r: Double

Absolute value of complex number.

reciprocal

val Complex.reciprocal: Complex

This complex's reciprocal.

val Quaternion.reciprocal: Quaternion

This quaternion's reciprocal.

theta

val Complex.theta: Double

An angle between vector represented by complex number and X axis.