Public Member Functions
VariableMatrix	__mul__ (self, VariableMatrix rhs)

VariableMatrix	__mul__ (self, Variable rhs)

VariableMatrix	__mul__ (self, float rhs)

VariableMatrix	__add__ (self, VariableMatrix rhs)

VariableMatrix	__add__ (self, VariableBlock rhs)

VariableMatrix	__add__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)

VariableMatrix	__add__ (self, VariableBlock rhs)

VariableMatrix	__sub__ (self, VariableMatrix rhs)

VariableMatrix	__sub__ (self, VariableBlock rhs)

VariableMatrix	__sub__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)

VariableMatrix	__sub__ (self, VariableBlock rhs)

EqualityConstraints	__eq__ (self, VariableMatrix rhs)

EqualityConstraints	__eq__ (self, VariableBlock rhs)

EqualityConstraints	__eq__ (self, Variable rhs)

EqualityConstraints	__eq__ (self, float rhs)

EqualityConstraints	__eq__ (self, int rhs)

EqualityConstraints	__eq__ (self, Variable lhs)

EqualityConstraints	__eq__ (self, float lhs)

EqualityConstraints	__eq__ (self, int lhs)

EqualityConstraints	__eq__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)

InequalityConstraints	__lt__ (self, VariableMatrix rhs)

InequalityConstraints	__lt__ (self, VariableBlock rhs)

InequalityConstraints	__lt__ (self, Variable rhs)

InequalityConstraints	__lt__ (self, float rhs)

InequalityConstraints	__lt__ (self, int rhs)

InequalityConstraints	__lt__ (self, Variable lhs)

InequalityConstraints	__lt__ (self, float lhs)

InequalityConstraints	__lt__ (self, int lhs)

InequalityConstraints	__lt__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)

InequalityConstraints	__le__ (self, VariableMatrix rhs)

InequalityConstraints	__le__ (self, VariableBlock rhs)

InequalityConstraints	__le__ (self, Variable rhs)

InequalityConstraints	__le__ (self, float rhs)

InequalityConstraints	__le__ (self, int rhs)

InequalityConstraints	__le__ (self, Variable lhs)

InequalityConstraints	__le__ (self, float lhs)

InequalityConstraints	__le__ (self, int lhs)

InequalityConstraints	__le__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)

InequalityConstraints	__gt__ (self, VariableMatrix rhs)

InequalityConstraints	__gt__ (self, Variable lhs)

InequalityConstraints	__gt__ (self, float lhs)

InequalityConstraints	__gt__ (self, int lhs)

InequalityConstraints	__gt__ (self, VariableBlock rhs)

InequalityConstraints	__gt__ (self, Variable rhs)

InequalityConstraints	__gt__ (self, float rhs)

InequalityConstraints	__gt__ (self, int rhs)

InequalityConstraints	__gt__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)

InequalityConstraints	__ge__ (self, VariableMatrix rhs)

InequalityConstraints	__ge__ (self, Variable lhs)

InequalityConstraints	__ge__ (self, float lhs)

InequalityConstraints	__ge__ (self, int lhs)

InequalityConstraints	__ge__ (self, VariableBlock rhs)

InequalityConstraints	__ge__ (self, Variable rhs)

InequalityConstraints	__ge__ (self, float rhs)

InequalityConstraints	__ge__ (self, int rhs)

InequalityConstraints	__ge__ (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] rhs)

None	set_value (self, float value)

None	set_value (self, Annotated[NDArray[numpy.float64], dict(shape=(None, None))] values)

None	set_value (self, Annotated[NDArray[numpy.float32], dict(shape=(None, None))] values)

None	set_value (self, Annotated[NDArray[numpy.int64], dict(shape=(None, None))] values)

None	set_value (self, Annotated[NDArray[numpy.int32], dict(shape=(None, None))] values)

Variable	__setitem__ (self, int row, Variable value)

None	__setitem__ (self, tuple slices, object value)

Variable	__getitem__ (self, int row)

object	__getitem__ (self, tuple slices)

VariableBlock	row (self, int row)

VariableBlock	col (self, int col)

object	__array_ufunc__ (self, object ufunc, str method, inputs, *kwargs)

VariableMatrix	__rmul__ (self, Variable lhs)

VariableMatrix	__rmul__ (self, float lhs)

VariableMatrix	__truediv__ (self, Variable rhs)

VariableMatrix	__truediv__ (self, float rhs)

VariableMatrix	__neg__ (self)

VariableMatrix	T (self)

int	rows (self)

int	cols (self)

tuple	shape (self)

float	value (self, int row, int col)

float	value (self, int index)

Annotated[NDArray[numpy.float64], dict(shape=(None, None), order='F')]	value (self)

VariableMatrix	cwise_map (self, Callable[[Variable], Variable] func)

int	__len__ (self)

Iterator[Variable]	__iter__ (self)

Detailed Description

A submatrix of autodiff variables with reference semantics.

Template parameter ``Mat``:
    The type of the matrix whose storage this class points to.

Member Function Documentation

◆ add() [1/4]

VariableMatrix jormungandr.autodiff.VariableBlock.__add__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

◆ add() [2/4]

VariableMatrix jormungandr.autodiff.VariableBlock.__add__	(		self,
		VariableBlock	rhs
	)

◆ add() [3/4]

VariableMatrix jormungandr.autodiff.VariableBlock.__add__	(		self,
		VariableBlock	rhs
	)

◆ add() [4/4]

VariableMatrix jormungandr.autodiff.VariableBlock.__add__	(		self,
		VariableMatrix	rhs
	)

◆ __array_ufunc__()

object jormungandr.autodiff.VariableBlock.__array_ufunc__	(		self,
		object	ufunc,
		str	method,
		*	inputs,
		**	kwargs
	)

◆ eq() [1/9]

EqualityConstraints jormungandr.autodiff.VariableBlock.__eq__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

◆ eq() [2/9]

EqualityConstraints jormungandr.autodiff.VariableBlock.__eq__	(		self,
		float	lhs
	)

◆ eq() [3/9]

EqualityConstraints jormungandr.autodiff.VariableBlock.__eq__	(		self,
		float	rhs
	)

◆ eq() [4/9]

EqualityConstraints jormungandr.autodiff.VariableBlock.__eq__	(		self,
		int	lhs
	)

◆ eq() [5/9]

EqualityConstraints jormungandr.autodiff.VariableBlock.__eq__	(		self,
		int	rhs
	)

◆ eq() [6/9]

EqualityConstraints jormungandr.autodiff.VariableBlock.__eq__	(		self,
		Variable	lhs
	)

◆ eq() [7/9]

EqualityConstraints jormungandr.autodiff.VariableBlock.__eq__	(		self,
		Variable	rhs
	)

◆ eq() [8/9]

EqualityConstraints jormungandr.autodiff.VariableBlock.__eq__	(		self,
		VariableBlock	rhs
	)

◆ eq() [9/9]

EqualityConstraints jormungandr.autodiff.VariableBlock.__eq__	(		self,
		VariableMatrix	rhs
	)

Equality operator that returns an equality constraint for two
Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ ge() [1/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__ge__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

Greater-than-or-equal-to comparison operator that returns an
inequality constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ ge() [2/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__ge__	(		self,
		float	lhs
	)

Less-than-or-equal-to comparison operator that returns an inequality
constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ ge() [3/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__ge__	(		self,
		float	rhs
	)

Greater-than-or-equal-to comparison operator that returns an
inequality constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ ge() [4/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__ge__	(		self,
		int	lhs
	)

Less-than-or-equal-to comparison operator that returns an inequality
constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ ge() [5/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__ge__	(		self,
		int	rhs
	)

Greater-than-or-equal-to comparison operator that returns an
inequality constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ ge() [6/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__ge__	(		self,
		Variable	lhs
	)

Less-than-or-equal-to comparison operator that returns an inequality
constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ ge() [7/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__ge__	(		self,
		Variable	rhs
	)

Greater-than-or-equal-to comparison operator that returns an
inequality constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ ge() [8/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__ge__	(		self,
		VariableBlock	rhs
	)

Greater-than-or-equal-to comparison operator that returns an
inequality constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ ge() [9/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__ge__	(		self,
		VariableMatrix	rhs
	)

Greater-than-or-equal-to comparison operator that returns an
inequality constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ getitem() [1/2]

Variable jormungandr.autodiff.VariableBlock.__getitem__	(		self,
		int	row
	)

Returns a scalar subblock at the given index.

Parameter ``index``:
    The scalar subblock's index.

Returns:
    A scalar subblock at the given index.

◆ getitem() [2/2]

object jormungandr.autodiff.VariableBlock.__getitem__	(		self,
		tuple	slices
	)

Returns a scalar subblock at the given row and column.

Parameter ``row``:
    The scalar subblock's row.

Parameter ``col``:
    The scalar subblock's column.

Returns:
    A scalar subblock at the given row and column.

◆ gt() [1/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__gt__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

Greater-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ gt() [2/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__gt__	(		self,
		float	lhs
	)

Less-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ gt() [3/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__gt__	(		self,
		float	rhs
	)

Greater-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ gt() [4/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__gt__	(		self,
		int	lhs
	)

Less-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ gt() [5/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__gt__	(		self,
		int	rhs
	)

Greater-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ gt() [6/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__gt__	(		self,
		Variable	lhs
	)

Less-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ gt() [7/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__gt__	(		self,
		Variable	rhs
	)

Greater-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ gt() [8/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__gt__	(		self,
		VariableBlock	rhs
	)

Greater-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ gt() [9/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__gt__	(		self,
		VariableMatrix	rhs
	)

Greater-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ iter()

Iterator[Variable] jormungandr.autodiff.VariableBlock.__iter__ ( self )

◆ le() [1/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__le__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

Less-than-or-equal-to comparison operator that returns an inequality
constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ le() [2/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__le__	(		self,
		float	lhs
	)

Greater-than-or-equal-to comparison operator that returns an
inequality constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ le() [3/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__le__	(		self,
		float	rhs
	)

Less-than-or-equal-to comparison operator that returns an inequality
constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ le() [4/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__le__	(		self,
		int	lhs
	)

Greater-than-or-equal-to comparison operator that returns an
inequality constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ le() [5/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__le__	(		self,
		int	rhs
	)

Less-than-or-equal-to comparison operator that returns an inequality
constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ le() [6/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__le__	(		self,
		Variable	lhs
	)

Greater-than-or-equal-to comparison operator that returns an
inequality constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ le() [7/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__le__	(		self,
		Variable	rhs
	)

Less-than-or-equal-to comparison operator that returns an inequality
constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ le() [8/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__le__	(		self,
		VariableBlock	rhs
	)

Less-than-or-equal-to comparison operator that returns an inequality
constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ le() [9/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__le__	(		self,
		VariableMatrix	rhs
	)

Less-than-or-equal-to comparison operator that returns an inequality
constraint for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ len()

int jormungandr.autodiff.VariableBlock.__len__ ( self )

Returns the number of rows in the matrix.

Returns:
    The number of rows in the matrix.

◆ lt() [1/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__lt__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

Less-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ lt() [2/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__lt__	(		self,
		float	lhs
	)

Greater-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ lt() [3/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__lt__	(		self,
		float	rhs
	)

Less-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ lt() [4/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__lt__	(		self,
		int	lhs
	)

Greater-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ lt() [5/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__lt__	(		self,
		int	rhs
	)

Less-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ lt() [6/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__lt__	(		self,
		Variable	lhs
	)

Greater-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ lt() [7/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__lt__	(		self,
		Variable	rhs
	)

Less-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ lt() [8/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__lt__	(		self,
		VariableBlock	rhs
	)

Less-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ lt() [9/9]

InequalityConstraints jormungandr.autodiff.VariableBlock.__lt__	(		self,
		VariableMatrix	rhs
	)

Less-than comparison operator that returns an inequality constraint
for two Variables.

Parameter ``lhs``:
    Left-hand side.

Parameter ``rhs``:
    Left-hand side.

◆ mul() [1/3]

VariableMatrix jormungandr.autodiff.VariableBlock.__mul__	(		self,
		float	rhs
	)

◆ mul() [2/3]

VariableMatrix jormungandr.autodiff.VariableBlock.__mul__	(		self,
		Variable	rhs
	)

◆ mul() [3/3]

VariableMatrix jormungandr.autodiff.VariableBlock.__mul__	(		self,
		VariableMatrix	rhs
	)

◆ neg()

VariableMatrix jormungandr.autodiff.VariableBlock.__neg__ ( self )

◆ rmul() [1/2]

VariableMatrix jormungandr.autodiff.VariableBlock.__rmul__	(		self,
		float	lhs
	)

◆ rmul() [2/2]

VariableMatrix jormungandr.autodiff.VariableBlock.__rmul__	(		self,
		Variable	lhs
	)

◆ setitem() [1/2]

Variable jormungandr.autodiff.VariableBlock.__setitem__	(		self,
		int	row,
		Variable	value
	)

◆ setitem() [2/2]

None jormungandr.autodiff.VariableBlock.__setitem__	(		self,
		tuple	slices,
		object	value
	)

◆ sub() [1/4]

VariableMatrix jormungandr.autodiff.VariableBlock.__sub__	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	rhs
	)

◆ sub() [2/4]

VariableMatrix jormungandr.autodiff.VariableBlock.__sub__	(		self,
		VariableBlock	rhs
	)

◆ sub() [3/4]

VariableMatrix jormungandr.autodiff.VariableBlock.__sub__	(		self,
		VariableBlock	rhs
	)

◆ sub() [4/4]

VariableMatrix jormungandr.autodiff.VariableBlock.__sub__	(		self,
		VariableMatrix	rhs
	)

◆ truediv() [1/2]

VariableMatrix jormungandr.autodiff.VariableBlock.__truediv__	(		self,
		float	rhs
	)

◆ truediv() [2/2]

VariableMatrix jormungandr.autodiff.VariableBlock.__truediv__	(		self,
		Variable	rhs
	)

◆ col()

VariableBlock jormungandr.autodiff.VariableBlock.col	(		self,
		int	col
	)

Returns a column slice of the variable matrix.

Parameter ``col``:
    The column to slice.

Returns:
    A column slice of the variable matrix.

◆ cols()

int jormungandr.autodiff.VariableBlock.cols ( self )

Returns the number of columns in the matrix.

Returns:
    The number of columns in the matrix.

◆ cwise_map()

VariableMatrix jormungandr.autodiff.VariableBlock.cwise_map	(		self,
		Callable[[Variable], Variable]	func
	)

Transforms the matrix coefficient-wise with an unary operator.

Parameter ``unary_op``:
    The unary operator to use for the transform operation.

Returns:
    Result of the unary operator.

◆ row()

VariableBlock jormungandr.autodiff.VariableBlock.row	(		self,
		int	row
	)

Returns a row slice of the variable matrix.

Parameter ``row``:
    The row to slice.

Returns:
    A row slice of the variable matrix.

◆ rows()

int jormungandr.autodiff.VariableBlock.rows ( self )

Returns the number of rows in the matrix.

Returns:
    The number of rows in the matrix.

◆ set_value() [1/5]

None jormungandr.autodiff.VariableBlock.set_value	(		self,
		Annotated[NDArray[numpy.float32], dict(shape=(None, None))]	values
	)

Sets block's internal values.

Parameter ``values``:
    Eigen matrix of values.

◆ set_value() [2/5]

None jormungandr.autodiff.VariableBlock.set_value	(		self,
		Annotated[NDArray[numpy.float64], dict(shape=(None, None))]	values
	)

Sets block's internal values.

Parameter ``values``:
    Eigen matrix of values.

◆ set_value() [3/5]

None jormungandr.autodiff.VariableBlock.set_value	(		self,
		Annotated[NDArray[numpy.int32], dict(shape=(None, None))]	values
	)

Sets block's internal values.

Parameter ``values``:
    Eigen matrix of values.

◆ set_value() [4/5]

None jormungandr.autodiff.VariableBlock.set_value	(		self,
		Annotated[NDArray[numpy.int64], dict(shape=(None, None))]	values
	)

Sets block's internal values.

Parameter ``values``:
    Eigen matrix of values.

◆ set_value() [5/5]

None jormungandr.autodiff.VariableBlock.set_value	(		self,
		float	value
	)

Assigns a scalar to the block.

This only works for blocks with one row and one column.

Parameter ``value``:
    Value to assign.

◆ shape()

tuple jormungandr.autodiff.VariableBlock.shape ( self )

◆ T()

VariableMatrix jormungandr.autodiff.VariableBlock.T ( self )

Returns the transpose of the variable matrix.

Returns:
    The transpose of the variable matrix.

◆ value() [1/3]

Annotated[NDArray[numpy.float64], dict(shape=(None, None), order='F')] jormungandr.autodiff.VariableBlock.value ( self )

Returns the contents of the variable matrix.

Returns:
    The contents of the variable matrix.

◆ value() [2/3]

float jormungandr.autodiff.VariableBlock.value	(		self,
		int	index
	)

Returns an element of the variable block.

Parameter ``index``:
    The index of the element to return.

Returns:
    An element of the variable block.

◆ value() [3/3]

float jormungandr.autodiff.VariableBlock.value	(		self,
		int	row,
		int	col
	)

Returns an element of the variable matrix.

Parameter ``row``:
    The row of the element to return.

Parameter ``col``:
    The column of the element to return.

Returns:
    An element of the variable matrix.

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

jormungandr/autodiff/__init__.py

Public Member Functions

Detailed Description

Member Function Documentation

◆ __add__() [1/4]

◆ __add__() [2/4]

◆ __add__() [3/4]

◆ __add__() [4/4]

◆ __array_ufunc__()

◆ __eq__() [1/9]

◆ __eq__() [2/9]

◆ __eq__() [3/9]

◆ __eq__() [4/9]

◆ __eq__() [5/9]

◆ __eq__() [6/9]

◆ __eq__() [7/9]

◆ __eq__() [8/9]

◆ __eq__() [9/9]

◆ __ge__() [1/9]

◆ __ge__() [2/9]

◆ __ge__() [3/9]

◆ __ge__() [4/9]

◆ __ge__() [5/9]

◆ __ge__() [6/9]

◆ __ge__() [7/9]

◆ __ge__() [8/9]

◆ __ge__() [9/9]

◆ __getitem__() [1/2]

◆ __getitem__() [2/2]

◆ __gt__() [1/9]

◆ __gt__() [2/9]

◆ __gt__() [3/9]

◆ __gt__() [4/9]

◆ __gt__() [5/9]

◆ __gt__() [6/9]

◆ __gt__() [7/9]

◆ __gt__() [8/9]

◆ __gt__() [9/9]

◆ __iter__()

◆ __le__() [1/9]

◆ __le__() [2/9]

◆ __le__() [3/9]

◆ __le__() [4/9]

◆ __le__() [5/9]

◆ __le__() [6/9]

◆ __le__() [7/9]

◆ __le__() [8/9]

◆ __le__() [9/9]

◆ __len__()

◆ __lt__() [1/9]

◆ __lt__() [2/9]

◆ __lt__() [3/9]

◆ __lt__() [4/9]

◆ __lt__() [5/9]

◆ __lt__() [6/9]

◆ __lt__() [7/9]

◆ __lt__() [8/9]

◆ __lt__() [9/9]

◆ __mul__() [1/3]

◆ __mul__() [2/3]

◆ __mul__() [3/3]

◆ __neg__()

◆ __rmul__() [1/2]

◆ __rmul__() [2/2]

◆ __setitem__() [1/2]

◆ __setitem__() [2/2]

◆ __sub__() [1/4]

◆ __sub__() [2/4]

◆ __sub__() [3/4]

◆ __sub__() [4/4]

◆ __truediv__() [1/2]

◆ __truediv__() [2/2]