dist_m4ri.DistanceResult Class Reference

Public Member Functions
	__init__ (self, int dmin, int dmax, int rw_steps=0, Optional[List[List[int]]] cws=None, Optional[List[List[int]]] cws_X=None, Optional[List[List[int]]] cws_Z=None, Optional[int] dmin_X=None, Optional[int] dmax_X=None, Optional[int] rw_steps_X=None, Optional[int] dmin_Z=None, Optional[int] dmax_Z=None, Optional[int] rw_steps_Z=None)
bool	is_exact (self)
int	dist (self)
int	__int__ (self)
int	__index__ (self)
bool	__eq__ (self, Any other)
	__iter__ (self)
	__getitem__ (self, int index)
int	__len__ (self)
str	__str__ (self)
str	__repr__ (self)

Public Attributes
	dmin = dmin
	dmax = dmax
	rw_steps = rw_steps
	cws = cws
	cws_X = cws_X
	cws_Z = cws_Z
	dmin_X = dmin_X
	dmax_X = dmax_X
	rw_steps_X = rw_steps_X
	dmin_Z = dmin_Z
	dmax_Z = dmax_Z
	rw_steps_Z = rw_steps_Z
	dist = other
	is_exact

Protected Member Functions
tuple	_fields (self)

Detailed Description

Structured result for code distance calculations containing:
- dmin: lower bound on distance
- dmax: upper bound on distance (minimum non-trivial codeword weight found)
- rw_steps: cumulative number of completed random window information sets
- cws: discovered codewords (if requested)

Definition at line 1005 of file dist_m4ri.py.

Constructor & Destructor Documentation

__init__()

dist_m4ri.DistanceResult.__init__	(		self,
		int	dmin,
		int	dmax,
		int	rw_steps = 0,
		Optional[List[List[int]]]	cws = None,
		Optional[List[List[int]]]	cws_X = None,
		Optional[List[List[int]]]	cws_Z = None,
		Optional[int]	dmin_X = None,
		Optional[int]	dmax_X = None,
		Optional[int]	rw_steps_X = None,
		Optional[int]	dmin_Z = None,
		Optional[int]	dmax_Z = None,
		Optional[int]	rw_steps_Z = None )

Definition at line 1013 of file dist_m4ri.py.

Member Function Documentation

__eq__()

bool dist_m4ri.DistanceResult.__eq__	(		self,
		Any	other )

Definition at line 1055 of file dist_m4ri.py.

References _fields(), dmax, dmin, and rw_steps.

__getitem__()

dist_m4ri.DistanceResult.__getitem__	(		self,
		int	index )

Definition at line 1075 of file dist_m4ri.py.

References _fields().

__index__()

int dist_m4ri.DistanceResult.__index__

(

self

)

Definition at line 1052 of file dist_m4ri.py.

References dist.

__int__()

int dist_m4ri.DistanceResult.__int__

(

self

)

Definition at line 1049 of file dist_m4ri.py.

References dist.

__iter__()

dist_m4ri.DistanceResult.__iter__

(

self

)

Definition at line 1072 of file dist_m4ri.py.

References _fields().

__len__()

int dist_m4ri.DistanceResult.__len__

(

self

)

Definition at line 1078 of file dist_m4ri.py.

References _fields().

__repr__()

str dist_m4ri.DistanceResult.__repr__

(

self

)

Definition at line 1086 of file dist_m4ri.py.

References is_exact.

__str__()

str dist_m4ri.DistanceResult.__str__

(

self

)

Definition at line 1081 of file dist_m4ri.py.

_fields()

tuple dist_m4ri.DistanceResult._fields ( self )

protected

The result as a tuple (dmin, dmax, rw_steps[, cws] or [, cws_X, cws_Z]).

Definition at line 1064 of file dist_m4ri.py.

References cws, cws_X, cws_Z, dmax, dmin, and rw_steps.

Referenced by __eq__(), __getitem__(), __iter__(), and __len__().

dist()

int dist_m4ri.DistanceResult.dist

(

self

)

Definition at line 1046 of file dist_m4ri.py.

References dmax, dmin, and is_exact.

is_exact()

bool dist_m4ri.DistanceResult.is_exact

(

self

)

Definition at line 1042 of file dist_m4ri.py.

References dmax, and dmin.

Member Data Documentation

cws

dist_m4ri.DistanceResult.cws = cws

Definition at line 1031 of file dist_m4ri.py.

Referenced by _fields().

cws_X

dist_m4ri.DistanceResult.cws_X = cws_X

Definition at line 1032 of file dist_m4ri.py.

Referenced by _fields().

cws_Z

dist_m4ri.DistanceResult.cws_Z = cws_Z

Definition at line 1033 of file dist_m4ri.py.

Referenced by _fields().

dist

dist_m4ri.DistanceResult.dist = other

Definition at line 1061 of file dist_m4ri.py.

Referenced by __index__(), and __int__().

dmax

dist_m4ri.DistanceResult.dmax = dmax

Definition at line 1029 of file dist_m4ri.py.

Referenced by __eq__(), _fields(), dist(), and is_exact().

dmax_X

dist_m4ri.DistanceResult.dmax_X = dmax_X

Definition at line 1035 of file dist_m4ri.py.

dmax_Z

dist_m4ri.DistanceResult.dmax_Z = dmax_Z

Definition at line 1038 of file dist_m4ri.py.

dmin

dist_m4ri.DistanceResult.dmin = dmin

Definition at line 1028 of file dist_m4ri.py.

Referenced by __eq__(), _fields(), dist(), and is_exact().

dmin_X

dist_m4ri.DistanceResult.dmin_X = dmin_X

Definition at line 1034 of file dist_m4ri.py.

dmin_Z

dist_m4ri.DistanceResult.dmin_Z = dmin_Z

Definition at line 1037 of file dist_m4ri.py.

is_exact

dist_m4ri.DistanceResult.is_exact

Definition at line 1082 of file dist_m4ri.py.

Referenced by __repr__(), and dist().

rw_steps

dist_m4ri.DistanceResult.rw_steps = rw_steps

Definition at line 1030 of file dist_m4ri.py.

Referenced by __eq__(), and _fields().

rw_steps_X

dist_m4ri.DistanceResult.rw_steps_X = rw_steps_X

Definition at line 1036 of file dist_m4ri.py.

rw_steps_Z

dist_m4ri.DistanceResult.rw_steps_Z = rw_steps_Z

Definition at line 1039 of file dist_m4ri.py.

---

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

• dist_m4ri.py