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
	dmax
	rw_steps
	cws
	cws_X
	cws_Z
	dmin_X
	dmax_X
	rw_steps_X
	dmin_Z
	dmax_Z
	rw_steps_Z
	dist

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 461 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 469 of file dist_m4ri.py.

Member Function Documentation

__eq__()

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

Definition at line 511 of file dist_m4ri.py.

References dist_m4ri.DistanceResult.dmax, distfork_ctx_t.dmax, params_t.dmax, dist_m4ri.DistanceResult.dmin, distfork_ctx_t.dmin, params_t.dmin, and dist_m4ri.DistanceResult.rw_steps.

__getitem__()

dist_m4ri.DistanceResult.__getitem__	(		self,
		int	index
	)

Definition at line 527 of file dist_m4ri.py.

__index__()

int dist_m4ri.DistanceResult.__index__

(

self

)

Definition at line 508 of file dist_m4ri.py.

References dist_m4ri.DistanceResult.dist(), dist_m4ri.DistanceResult.dist, and params_t.dist.

__int__()

int dist_m4ri.DistanceResult.__int__

(

self

)

Definition at line 505 of file dist_m4ri.py.

References dist_m4ri.DistanceResult.dist(), dist_m4ri.DistanceResult.dist, and params_t.dist.

__iter__()

dist_m4ri.DistanceResult.__iter__

(

self

)

Definition at line 520 of file dist_m4ri.py.

References dist_m4ri.DistanceResult.cws, dist_m4ri.DistanceResult.cws_X, dist_m4ri.DistanceResult.cws_Z, dist_m4ri.DistanceResult.dmax, distfork_ctx_t.dmax, params_t.dmax, dist_m4ri.DistanceResult.dmin, distfork_ctx_t.dmin, params_t.dmin, and dist_m4ri.DistanceResult.rw_steps.

__len__()

int dist_m4ri.DistanceResult.__len__

(

self

)

Definition at line 530 of file dist_m4ri.py.

__repr__()

str dist_m4ri.DistanceResult.__repr__

(

self

)

Definition at line 538 of file dist_m4ri.py.

References dist_m4ri.DistanceResult.is_exact().

__str__()

str dist_m4ri.DistanceResult.__str__

(

self

)

Definition at line 533 of file dist_m4ri.py.

References dist_m4ri.DistanceResult.is_exact().

dist()

int dist_m4ri.DistanceResult.dist

(

self

)

Definition at line 502 of file dist_m4ri.py.

References dist_m4ri.DistanceResult.dmax, distfork_ctx_t.dmax, params_t.dmax, dist_m4ri.DistanceResult.dmin, distfork_ctx_t.dmin, params_t.dmin, and dist_m4ri.DistanceResult.is_exact().

Referenced by dist_m4ri.DistanceResult.__index__(), and dist_m4ri.DistanceResult.__int__().

is_exact()

bool dist_m4ri.DistanceResult.is_exact

(

self

)

Definition at line 498 of file dist_m4ri.py.

References dist_m4ri.DistanceResult.dmax, distfork_ctx_t.dmax, params_t.dmax, dist_m4ri.DistanceResult.dmin, distfork_ctx_t.dmin, and params_t.dmin.

Referenced by dist_m4ri.DistanceResult.__repr__(), dist_m4ri.DistanceResult.__str__(), and dist_m4ri.DistanceResult.dist().

Member Data Documentation

cws

dist_m4ri.DistanceResult.cws

Definition at line 487 of file dist_m4ri.py.

Referenced by dist_m4ri.DistanceResult.__iter__().

cws_X

dist_m4ri.DistanceResult.cws_X

Definition at line 488 of file dist_m4ri.py.

Referenced by dist_m4ri.DistanceResult.__iter__().

cws_Z

dist_m4ri.DistanceResult.cws_Z

Definition at line 489 of file dist_m4ri.py.

Referenced by dist_m4ri.DistanceResult.__iter__().

dist

dist_m4ri.DistanceResult.dist

Definition at line 517 of file dist_m4ri.py.

Referenced by dist_m4ri.DistanceResult.__index__(), and dist_m4ri.DistanceResult.__int__().

dmax

dist_m4ri.DistanceResult.dmax

Definition at line 485 of file dist_m4ri.py.

Referenced by dist_m4ri.DistanceResult.__eq__(), dist_m4ri.DistanceResult.__iter__(), dist_m4ri.DistanceResult.dist(), and dist_m4ri.DistanceResult.is_exact().

dmax_X

dist_m4ri.DistanceResult.dmax_X

Definition at line 491 of file dist_m4ri.py.

dmax_Z

dist_m4ri.DistanceResult.dmax_Z

Definition at line 494 of file dist_m4ri.py.

dmin

dist_m4ri.DistanceResult.dmin

Definition at line 484 of file dist_m4ri.py.

Referenced by dist_m4ri.DistanceResult.__eq__(), dist_m4ri.DistanceResult.__iter__(), dist_m4ri.DistanceResult.dist(), and dist_m4ri.DistanceResult.is_exact().

dmin_X

dist_m4ri.DistanceResult.dmin_X

Definition at line 490 of file dist_m4ri.py.

dmin_Z

dist_m4ri.DistanceResult.dmin_Z

Definition at line 493 of file dist_m4ri.py.

rw_steps

dist_m4ri.DistanceResult.rw_steps

Definition at line 486 of file dist_m4ri.py.

Referenced by dist_m4ri.DistanceResult.__eq__(), and dist_m4ri.DistanceResult.__iter__().

rw_steps_X

dist_m4ri.DistanceResult.rw_steps_X

Definition at line 492 of file dist_m4ri.py.

rw_steps_Z

dist_m4ri.DistanceResult.rw_steps_Z

Definition at line 495 of file dist_m4ri.py.

---

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

• dist_m4ri.py