Surge/INVENTORY.md

Inventory

• Inventory
  • General Arithmetic Operations
    • Addition
    • Subtraction
    • Multiplication
    • Element-wise multiplication
    • Division)
    • Element-wise Division)
    • Modulo
    • Remainder
    • Square Root
    • Summation
    • Dot Product
    • Distance
    • Squared Distance
    • Power)
    • Exponential
  • Trigonometric Operations
    • Sine/Cosine/Tangent
    • Arc Sine/Cosine/Tangent
    • Hyperbolic Sine/Cosine/Tangent
    • Inverse Hyperbolic Sine/Cosine/Tangent
    • Radians ↔︎ Degrees
  • Exponential Function
  • Logarithm
  • Statistical Operations
    • Summation
    • Minimum/Maximum
    • Mean
  • Auxiliary Functions
    • Rounding Functions
    • Absolute value
    • Signum function
    • Multiplicative inverse
  • Matrix-specific Operations
    • Matrix Inversion
    • Matrix Transposition
    • Matrix Determinant
    • Eigen Decomposition
  • DSP-specific Operations
    • Fast Fourier Transform
    • Convolution
    • Cross-Correlation

General Arithmetic Operations

Addition

Addition functions & operators

Arguments	Function	Operator	In-Place Operator
(Array, Array)	add	.+ (infix)	.+= (infix)
(Array, Scalar)	add	+ (infix)	+= (infix)
(Matrix, Matrix)	add	+ (infix)	n/a
(Matrix, Scalar)	n/a	+ (infix)	n/a
(Vector, Vector)	func add	+ (infix)	+= (infix)
(Vector, Scalar)	func add	+ (infix)	+= (infix)

Subtraction

Subtraction functions & operators

Arguments	Function	Operator	In-Place Operator
(Array, Array)	sub	.- (infix)	.-= (infix)
(Array, Scalar)	sub	- (infix)	-= (infix)
(Matrix, Matrix)	sub	- (infix)	n/a
(Matrix, Scalar)	n/a	n/a	n/a
(Vector, Vector)	sub	- (infix)	-= (infix)
(Vector, Scalar)	sub	- (infix)	-= (infix)

Multiplication

Multiplication functions & operators

Arguments	Function	Operator	In-Place Operator
(Array, Array)	mul	.* (infix)	.*= (infix)
(Array, Scalar)	mul	* (infix)	*= (infix)
(Matrix, Matrix)	mul	* (infix)	n/a
(Matrix, Vector)	mul	* (infix)	n/a
(Matrix, Scalar)	mul	* (infix)	n/a
(Vector, Matrix)	mul	* (infix)	n/a
(Vector, Scalar)	mul	* (infix)	*= (infix)
(Scalar, Array)	mul	* (infix)	n/a
(Scalar, Matrix)	mul	* (infix)	n/a
(Scalar, Vector)	mul	* (infix)	n/a

Element-wise multiplication

Element-wise multiplication functions & operators

Arguments	Function	Operator	In-Place Operator
(Matrix, Matrix)	elmul	n/a	n/a
(Vector, Vector)	elmul	.* (infix)	.*= (infix)

Division

Division functions & operators

Arguments	Function	Operator	In-Place Operator
(Array, Array)	div	./ (infix)	./= (infix)
(Array, Scalar)	div	/ (infix)	/= (infix)
(Matrix, Matrix)	div	/ (infix)	n/a
(Matrix, Scalar)	n/a	/ (infix)	n/a
(Vector, Scalar)	div	/ (infix)	/= (infix)

Element-wise Division

Element-wise multiplication functions & operators

Arguments	Function	Operator	In-Place Operator
(Vector, Vector)	eldiv	./ (infix)	./= (infix)

Modulo

Modulo functions & operators

Arguments	Function	Operator	In-Place Operator
(Array, Array)	mod	.% (infix)	n/a
(Array, Scalar)	mod	% (infix)	n/a

Remainder

Remainder functions & operators

Arguments	Function	Operator	In-Place Operator
(Array, Array)	remainder	n/a	n/a
(Array, Scalar)	remainder	n/a	n/a

Square Root

Square root functions & operators

Arguments	Function	Operator	In-Place Operator
(Array)	sqrt	n/a	n/a

Summation

Sum functions & operators

Arguments	Function	Operator	In-Place Operator
(Array)	sum	n/a	n/a
(Matrix)	sum	n/a	n/a

Dot Product

Dot product functions & operators

Arguments	Function	Operator	In-Place Operator
(Array, Array)	dot	• (infix)	n/a
(Vector, Vector)	dot	• (infix)	n/a

Distance

Distance functions & operators

Arguments	Function	Operator	In-Place Operator
(Array, Array)	dist	n/a	n/a
(Vector, Vector)	dist	n/a	n/a

Squared Distance

Squared distance functions & operators

Arguments	Function	Operator	In-Place Operator
(Array, Array)	distSq	n/a	n/a
(Vector, Vector)	distSq	n/a	n/a

Power

Power functions & operators

Arguments	Function	Operator	In-Place Operator
(Array, Array)	pow	** (infix)	n/a
(Array, Scalar)	pow	** (infix)	n/a
(Matrix, Scalar)	pow	** (infix)	n/a
(Vector, Vector)	pow	n/a	n/a

Exponential

Exponential functions & operators

Arguments	Function	Operator	In-Place Operator
(Array)	exp	n/a	n/a
(Matrix)	exp	n/a	n/a
(Vector)	exp	n/a	n/a

Trigonometric Operations

Trigonometric functions & operators

Sine/Cosine/Tangent

Arguments	Function	Operation
(Array)	sin	Sine
(Array)	cos	Cosine
(Array)	tan	Tangent
(Array)	sincos	Sine & Cosine

Arc Sine/Cosine/Tangent

Arguments	Function	Operation
(Array)	asin	Arc Sine
(Array)	acos	Arc Cosine
(Array)	atan	Arc Tangent

Hyperbolic Sine/Cosine/Tangent

Arguments	Function	Operation
(Array)	sinh	Hyperbolic Sine
(Array)	cosh	Hyperbolic Cosine
(Array)	tanh	Hyperbolic Tangent

Inverse Hyperbolic Sine/Cosine/Tangent

Arguments	Function	Operation
(Array)	asinh	Inverse Hyperbolic Sine
(Array)	acosh	Inverse Hyperbolic Cosine
(Array)	atanh	Inverse Hyperbolic Tangent

Radians ↔︎ Degrees

Arguments	Function	Operation
(Array)	rad2deg	Radians to Degrees
(Array)	deg2rad	Degrees to Radians

Exponential Function

Exponential functions & operators

Arguments	Function	Operation
(Array)	exp	Base-e Exponential Function
(Array)	exp2	Base-2 Exponential Function

Logarithm

Exponential functions & operators

Arguments	Function	Operation
(Array)	log	Base-e Logarithm
(Array)	log2	Base-2 Logarithm
(Array)	log10	Base-10 Logarithm
(Array)	logb	Base-b Logarithm

Statistical Operations

Statistical functions & operators

Summation

Arguments	Function	Operation
(Array)	sum	Summation
(Array)	asum	Absolute Summation

Minimum/Maximum

Arguments	Function	Operation
(Array)	min	Minimum
(Array)	max	Maximum

Mean

Arguments	Function	Operation
(Array)	mean	Mean
(Array)	meamg	Mean of Magnitudes
(Array)	measq	Mean of squares

Auxiliary Functions

Auxiliary functions & operators

Rounding Functions

Arguments	Function	Operation
(Array)	ceil	Ceiling
(Array)	floor	Flooring
(Array)	round	Rounding
(Array)	trunc	Integer truncation

Absolute value

Arguments	Function	In-Place Function	Operator	In-Place Operator
(Array)	abs	n/a	n/a	n/a

Signum function

Arguments	Function	In-Place Function	Operator	In-Place Operator
(Array)	copysign	n/a	n/a	n/a

Multiplicative inverse

Arguments	Function	In-Place Function	Operator	In-Place Operator
(Array)	rec	n/a	n/a	n/a

Matrix-specific Operations

Matrix-specific functions & operators

Matrix Inversion

Arguments	Function	In-Place Function	Operator	In-Place Operator
(Matrix)	inv	n/a	n/a	n/a

Matrix Transposition

Arguments	Function	In-Place Function	Operator	In-Place Operator
(Matrix)	transpose	n/a	′ (postfix)	n/a

Matrix Determinant

Arguments	Function	In-Place Function	Operator	In-Place Operator
(Matrix)	det	n/a	n/a	n/a

Eigen Decomposition

Arguments	Function	In-Place Function	Operator	In-Place Operator
(Matrix)	eigenDecompose	n/a	n/a	n/a

DSP-specific Operations

Fast fourier transform functions & operators

Fast Fourier Transform

Arguments	Function	In-Place Function	Operator	In-Place Operator
(Array)	fft	n/a	n/a	n/a

Convolution

Arguments	Function	In-Place Function	Operator	In-Place Operator
(Array, Array)	conv	n/a	n/a	n/a

Cross-Correlation

Arguments	Function	In-Place Function	Operator	In-Place Operator
(Array, Array)	xcorr	n/a	n/a	n/a
(Array)	xcorr	n/a	n/a	n/a