AxisLayout Class Reference

Detailed Description

Layout of variables along an equation-system axis

Classes
class	IStructure

Public Member Functions
bool	__eq__ (self, AxisLayout arg0)
None	__init__ (self)
None	__init__ (self, list[list[str]] vars, list[tuple[int,...]] intmd_shapes, list[tuple[int,...]] base_shapes, list[AxisLayout.IStructure] istrs)
tuple[int,...]	base_sizes (self, int i)
AxisLayout	group (self, int i)
tuple[int, int]	group_offsets (self, int i)
tuple[int,...]	intmd_sizes (self, int i)
AxisLayout.IStructure	istr (self, int i=0)
int	ngroup (self)
int	nvar (self)
list[int]	storage_sizes (self, bool include_intmd)
str	var (self, int i)
list[str]	vars (self)
AxisLayout	view (self)
bool	is_view (self)

Static Public Attributes
typing	DENSE .ClassVar[AxisLayout.IStructure]

Constructor & Destructor Documentation

__init__() [1/2]

None __init__

(

self

)

__init__() [2/2]

None __init__	(		self,
		list[list[str]]	vars,
		list[tuple[int, ...]]	intmd_shapes,
		list[tuple[int, ...]]	base_shapes,
		list[AxisLayout.IStructure]	istrs )

Construct an AxisLayout.

:param vars:         List of variable groups; each group is a list of variable names
:param intmd_shapes: Intermediate shape for each variable (flattened across all groups)
:param base_shapes:  Base shape for each variable (flattened across all groups)
:param istrs:        IStructure for each variable group

Member Function Documentation

__eq__()

bool __eq__	(		self,
		AxisLayout	arg0 )

base_sizes()

tuple[int, ...] base_sizes	(		self,
		int	i )

Base shape of variable i

group()

AxisLayout group	(		self,
		int	i )

Contiguous view of variable group i

group_offsets()

tuple[int, int] group_offsets	(		self,
		int	i )

Starting and ending offsets (as a tuple) of variable group i

intmd_sizes()

tuple[int, ...] intmd_sizes	(		self,
		int	i )

Intermediate shape of variable i

is_view()

bool is_view

(

self

)

Whether this is a view into a parent layout

istr()

AxisLayout.IStructure istr	(		self,
		int	i = 0 )

IStructure of variable group i

ngroup()

int ngroup

(

self

)

Number of variable groups

nvar()

int nvar

(

self

)

Number of variables

storage_sizes()

list[int] storage_sizes	(		self,
		bool	include_intmd )

Storage size of each variable; pass include_intmd=True to include intermediate dimensions

var()

str var	(		self,
		int	i )

Name of variable i

vars()

list[str] vars

(

self

)

List of variable names

view()

AxisLayout view

(

self

)

Contiguous view of the entire layout

Member Data Documentation

DENSE

typing DENSE .ClassVar[AxisLayout.IStructure]

static