jormungandr.autodiff Namespace Reference

Classes
class	ExpressionType
class	Gradient
class	Hessian
class	Jacobian
class	Variable
class	VariableBlock
class	VariableMatrix

Functions
Variable	abs (float x)
Variable	abs (Variable x)
Variable	acos (float x)
Variable	acos (Variable x)
Variable	asin (float x)
Variable	asin (Variable x)
Variable	atan (float x)
Variable	atan (Variable x)
Variable	atan2 (float y, Variable x)
Variable	atan2 (Variable y, float x)
Variable	atan2 (Variable y, Variable x)
VariableMatrix	block (Sequence[Sequence[VariableMatrix]] list)
Variable	cos (float x)
Variable	cos (Variable x)
Variable	cosh (float x)
Variable	cosh (Variable x)
VariableMatrix	cwise_reduce (VariableMatrix lhs, VariableMatrix rhs, Callable[[Variable, Variable], Variable] func)
Variable	erf (float x)
Variable	erf (Variable x)
Variable	exp (float x)
Variable	exp (Variable x)
Variable	hypot (float x, Variable y)
Variable	hypot (Variable x, float y)
Variable	hypot (Variable x, Variable y)
Variable	hypot (Variable x, Variable y, Variable z)
Variable	log (float x)
Variable	log (Variable x)
Variable	log10 (float x)
Variable	log10 (Variable x)
Variable	pow (float base, Variable power)
Variable	pow (Variable base, float power)
Variable	pow (Variable base, Variable power)
Variable	sign (float x)
Variable	sign (Variable x)
Variable	sin (float x)
Variable	sin (Variable x)
Variable	sinh (float x)
Variable	sinh (Variable x)
VariableMatrix	solve (VariableMatrix A, VariableMatrix B)
Variable	sqrt (float x)
Variable	sqrt (Variable x)
Variable	tan (float x)
Variable	tan (Variable x)
Variable	tanh (float x)
Variable	tanh (Variable x)
	spy (scipy.sparse.csc_matrix mat)

Function Documentation

abs() [1/2]

Variable jormungandr.autodiff.abs

(

float

x

)

std::abs() for Variables.

Parameter ``x``:
    The argument.

abs() [2/2]

Variable jormungandr.autodiff.abs

(

Variable

x

)

acos() [1/2]

Variable jormungandr.autodiff.acos

(

float

x

)

std::acos() for Variables.

Parameter ``x``:
    The argument.

acos() [2/2]

Variable jormungandr.autodiff.acos

(

Variable

x

)

asin() [1/2]

Variable jormungandr.autodiff.asin

(

float

x

)

std::asin() for Variables.

Parameter ``x``:
    The argument.

asin() [2/2]

Variable jormungandr.autodiff.asin

(

Variable

x

)

atan() [1/2]

Variable jormungandr.autodiff.atan

(

float

x

)

std::atan() for Variables.

Parameter ``x``:
    The argument.

atan() [2/2]

Variable jormungandr.autodiff.atan

(

Variable

x

)

atan2() [1/3]

Variable jormungandr.autodiff.atan2	(	float	y,
		Variable	x
	)

std::atan2() for Variables.

Parameter ``y``:
    The y argument.

Parameter ``x``:
    The x argument.

atan2() [2/3]

Variable jormungandr.autodiff.atan2	(	Variable	y,
		float	x
	)

atan2() [3/3]

Variable jormungandr.autodiff.atan2	(	Variable	y,
		Variable	x
	)

block()

VariableMatrix jormungandr.autodiff.block

(

Sequence[Sequence[VariableMatrix]]

list

)

Assemble a VariableMatrix from a nested list of blocks.

Each row's blocks must have the same height, and the assembled block
rows must have the same width. For example, for the block matrix [[A,
B], [C]] to be constructible, the number of rows in A and B must
match, and the number of columns in [A, B] and [C] must match.

Parameter ``list``:
    The nested list of blocks.

cos() [1/2]

Variable jormungandr.autodiff.cos

(

float

x

)

std::cos() for Variables.

Parameter ``x``:
    The argument.

cos() [2/2]

Variable jormungandr.autodiff.cos

(

Variable

x

)

cosh() [1/2]

Variable jormungandr.autodiff.cosh

(

float

x

)

std::cosh() for Variables.

Parameter ``x``:
    The argument.

cosh() [2/2]

Variable jormungandr.autodiff.cosh

(

Variable

x

)

cwise_reduce()

VariableMatrix jormungandr.autodiff.cwise_reduce	(	VariableMatrix	lhs,
		VariableMatrix	rhs,
		Callable[[Variable, Variable], Variable]	func
	)

Applies a coefficient-wise reduce operation to two matrices.

Parameter ``lhs``:
    The left-hand side of the binary operator.

Parameter ``rhs``:
    The right-hand side of the binary operator.

Parameter ``binary_op``:
    The binary operator to use for the reduce operation.

erf() [1/2]

Variable jormungandr.autodiff.erf

(

float

x

)

std::erf() for Variables.

Parameter ``x``:
    The argument.

erf() [2/2]

Variable jormungandr.autodiff.erf

(

Variable

x

)

exp() [1/2]

Variable jormungandr.autodiff.exp

(

float

x

)

std::exp() for Variables.

Parameter ``x``:
    The argument.

exp() [2/2]

Variable jormungandr.autodiff.exp

(

Variable

x

)

hypot() [1/4]

Variable jormungandr.autodiff.hypot	(	float	x,
		Variable	y
	)

std::hypot() for Variables.

Parameter ``x``:
    The x argument.

Parameter ``y``:
    The y argument.

hypot() [2/4]

Variable jormungandr.autodiff.hypot	(	Variable	x,
		float	y
	)

std::hypot() for Variables.

Parameter ``x``:
    The x argument.

Parameter ``y``:
    The y argument.

hypot() [3/4]

Variable jormungandr.autodiff.hypot	(	Variable	x,
		Variable	y
	)

std::hypot() for Variables.

Parameter ``x``:
    The x argument.

Parameter ``y``:
    The y argument.

hypot() [4/4]

Variable jormungandr.autodiff.hypot	(	Variable	x,
		Variable	y,
		Variable	z
	)

std::hypot() for Variables.

Parameter ``x``:
    The x argument.

Parameter ``y``:
    The y argument.

Parameter ``z``:
    The z argument.

log() [1/2]

Variable jormungandr.autodiff.log

(

float

x

)

std::log() for Variables.

Parameter ``x``:
    The argument.

log() [2/2]

Variable jormungandr.autodiff.log

(

Variable

x

)

log10() [1/2]

Variable jormungandr.autodiff.log10

(

float

x

)

std::log10() for Variables.

Parameter ``x``:
    The argument.

log10() [2/2]

Variable jormungandr.autodiff.log10

(

Variable

x

)

pow() [1/3]

Variable jormungandr.autodiff.pow	(	float	base,
		Variable	power
	)

std::pow() for Variables.

Parameter ``base``:
    The base.

Parameter ``power``:
    The power.

pow() [2/3]

Variable jormungandr.autodiff.pow	(	Variable	base,
		float	power
	)

pow() [3/3]

Variable jormungandr.autodiff.pow	(	Variable	base,
		Variable	power
	)

sign() [1/2]

Variable jormungandr.autodiff.sign

(

float

x

)

sign() for Variables.

Parameter ``x``:
    The argument.

sign() [2/2]

Variable jormungandr.autodiff.sign

(

Variable

x

)

sin() [1/2]

Variable jormungandr.autodiff.sin

(

float

x

)

std::sin() for Variables.

Parameter ``x``:
    The argument.

sin() [2/2]

Variable jormungandr.autodiff.sin

(

Variable

x

)

sinh() [1/2]

Variable jormungandr.autodiff.sinh

(

float

x

)

std::sinh() for Variables.

Parameter ``x``:
    The argument.

sinh() [2/2]

Variable jormungandr.autodiff.sinh

(

Variable

x

)

solve()

VariableMatrix jormungandr.autodiff.solve	(	VariableMatrix	A,
		VariableMatrix	B
	)

Solves the VariableMatrix equation AX = B for X.

Parameter ``A``:
    The left-hand side.

Parameter ``B``:
    The right-hand side.

Returns:
    The solution X.

spy()

jormungandr.autodiff.spy

(

scipy.sparse.csc_matrix

mat

)

Plot the sparsity pattern of a sparse matrix.

Green points represent positive values and red points represent negative
values.

Parameter ``mat``:
    The sparse matrix.

sqrt() [1/2]

Variable jormungandr.autodiff.sqrt

(

float

x

)

std::sqrt() for Variables.

Parameter ``x``:
    The argument.

sqrt() [2/2]

Variable jormungandr.autodiff.sqrt

(

Variable

x

)

tan() [1/2]

Variable jormungandr.autodiff.tan

(

float

x

)

std::tan() for Variables.

Parameter ``x``:
    The argument.

tan() [2/2]

Variable jormungandr.autodiff.tan

(

Variable

x

)

tanh() [1/2]

Variable jormungandr.autodiff.tanh

(

float

x

)

std::tanh() for Variables.

Parameter ``x``:
    The argument.

tanh() [2/2]

Variable jormungandr.autodiff.tanh

(

Variable

x

)