jormungandr.autodiff.Jacobian Class Reference

Public Member Functions
None	__init__ (self, Variable variable, Variable wrt)
None	__init__ (self, Variable variable, VariableMatrix wrt)
None	__init__ (self, VariableMatrix variables, VariableMatrix wrt)
VariableMatrix	get (self)
scipy.sparse.csc_matrix[float]	value (self)

Detailed Description

This class calculates the Jacobian of a vector of variables with
respect to a vector of variables.

The Jacobian is only recomputed if the variable expression is
quadratic or higher order.

Template parameter ``Scalar``:
    Scalar type.

Constructor & Destructor Documentation

__init__() [1/3]

None jormungandr.autodiff.Jacobian.__init__	(		self,
		Variable	variable,
		Variable	wrt
	)

Constructs a Jacobian object.

Parameter ``variable``:
    Variable of which to compute the Jacobian.

Parameter ``wrt``:
    Variable with respect to which to compute the Jacobian.

__init__() [2/3]

None jormungandr.autodiff.Jacobian.__init__	(		self,
		Variable	variable,
		VariableMatrix	wrt
	)

__init__() [3/3]

None jormungandr.autodiff.Jacobian.__init__	(		self,
		VariableMatrix	variables,
		VariableMatrix	wrt
	)

Member Function Documentation

get()

VariableMatrix jormungandr.autodiff.Jacobian.get

(

self

)

Returns the Jacobian as a VariableMatrix.

This is useful when constructing optimization problems with
derivatives in them.

Returns:
    The Jacobian as a VariableMatrix.

value()

scipy.sparse.csc_matrix[float] jormungandr.autodiff.Jacobian.value

(

self

)

Evaluates the Jacobian at wrt's value.

Returns:
    The Jacobian at wrt's value.

---

The documentation for this class was generated from the following file:

• jormungandr/autodiff/__init__.py