PyClical Namespace Reference

Classes
class	clifford
class	index_set

Functions
def	index_set_hidden_doctests ()
def	clifford_hidden_doctests ()
def	e (obj)
def	istpq (p, q)
def	_test ()

Variables
	__version__ = str(glucat_package_version,'utf-8')
	lhs
	rhs
	threshold = error_squared_tol(rhs) if threshold is None else threshold
	None
	tol = error_squared_tol(rhs) if tol is None else tol
	obj
	i
	ixt
	fill
	scalar_epsilon = epsilon
float	pi = atan(clifford(1.0)) * 4.0
float	tau = atan(clifford(1.0)) * 8.0
	cl = clifford
	ist = index_set
def	ninf3 = e(4) + e(-1)
def	nbar3 = e(4) - e(-1)

Function Documentation

_test()

def PyClical._test ( )

private

Definition at line 1962 of file PyClical.pyx.

clifford_hidden_doctests()

def PyClical.clifford_hidden_doctests

(

)

Tests for functions that Doctest cannot see.

For clifford.__cinit__: Construct an object of type clifford.

>>> print(clifford(2))
2
>>> print(clifford(2.0))
2
>>> print(clifford(1.0e-1))
0.1
>>> print(clifford("2"))
2
>>> print(clifford("2{1,2,3}"))
2{1,2,3}
>>> print(clifford(clifford("2{1,2,3}")))
2{1,2,3}
>>> print(clifford("-{1}"))
-{1}
>>> print(clifford(2,index_set({1,2})))
2{1,2}
>>> print(clifford([2,3],index_set({1,2})))
2{1}+3{2}
>>> print(clifford([1,2]))
Traceback (most recent call last):
  ...
TypeError: Cannot initialize clifford object from <class 'list'>.
>>> print(clifford(None))
Traceback (most recent call last):
  ...
TypeError: Cannot initialize clifford object from <class 'NoneType'>.
>>> print(clifford(None,[1,2]))
Traceback (most recent call last):
  ...
TypeError: Cannot initialize clifford object from (<class 'NoneType'>, <class 'list'>).
>>> print(clifford([1,2],[1,2]))
Traceback (most recent call last):
  ...
TypeError: Cannot initialize clifford object from (<class 'list'>, <class 'list'>).
>>> print(clifford(""))
Traceback (most recent call last):
  ...
ValueError: Cannot initialize clifford object from invalid string ''.
>>> print(clifford("{"))
Traceback (most recent call last):
  ...
ValueError: Cannot initialize clifford object from invalid string '{'.
>>> print(clifford("{1"))
Traceback (most recent call last):
  ...
ValueError: Cannot initialize clifford object from invalid string '{1'.
>>> print(clifford("+"))
Traceback (most recent call last):
  ...
ValueError: Cannot initialize clifford object from invalid string '+'.
>>> print(clifford("-"))
Traceback (most recent call last):
  ...
ValueError: Cannot initialize clifford object from invalid string '-'.
>>> print(clifford("{1}+"))
Traceback (most recent call last):
  ...
ValueError: Cannot initialize clifford object from invalid string '{1}+'.

For clifford.__richcmp__: Compare objects of type clifford.

>>> clifford("{1}") == clifford("1{1}")
True
>>> clifford("{1}") != clifford("1.0{1}")
False
>>> clifford("{1}") != clifford("1.0")
True
>>> clifford("{1,2}") == None
False
>>> clifford("{1,2}") != None
True
>>> None == clifford("{1,2}")
False
>>> None != clifford("{1,2}")
True

Definition at line 1253 of file PyClical.pyx.

e()

def PyClical.e

(

obj

)

Abbreviation for clifford(index_set(obj)).

>>> print(e(1))
{1}
>>> print(e(-1))
{-1}
>>> print(e(0))
1

Definition at line 1936 of file PyClical.pyx.

Referenced by glucat::matrix_multi< Scalar_T, LO, HI, Tune_P >.basis_element(), clifford_to_str(), glucat::framed_multi< Scalar_T, LO, HI, Tune_P >.framed_multi(), glucat::matrix_multi< Scalar_T, LO, HI, Tune_P >.matrix_multi(), and glucat.try_catch().

index_set_hidden_doctests()

def PyClical.index_set_hidden_doctests

(

)

Tests for functions that Doctest cannot see.

For index_set.__cinit__: Construct index_set.

>>> print(index_set(1))
{1}
>>> print(index_set({1,2}))
{1,2}
>>> print(index_set(index_set({1,2})))
{1,2}
>>> print(index_set({1,2}))
{1,2}
>>> print(index_set({1,2,1}))
{1,2}
>>> print(index_set({1,2,1}))
{1,2}
>>> print(index_set(""))
{}
>>> print(index_set("{"))
Traceback (most recent call last):
...
ValueError: Cannot initialize index_set object from invalid string '{'.
>>> print(index_set("{1"))
Traceback (most recent call last):
...
ValueError: Cannot initialize index_set object from invalid string '{1'.
>>> print(index_set("{1,2,100}"))
Traceback (most recent call last):
...
ValueError: Cannot initialize index_set object from invalid string '{1,2,100}'.
>>> print(index_set({1,2,100}))
Traceback (most recent call last):
...
IndexError: Cannot initialize index_set object from invalid {1, 2, 100}.
>>> print(index_set([1,2]))
Traceback (most recent call last):
...
TypeError: Cannot initialize index_set object from <class 'list'>.

For index_set.__richcmp__: Compare two objects of class index_set.

>>> index_set(1) == index_set({1})
True
>>> index_set({1}) != index_set({1})
False
>>> index_set({1}) != index_set({2})
True
>>> index_set({1}) == index_set({2})
False
>>> index_set({1}) < index_set({2})
True
>>> index_set({1}) <= index_set({2})
True
>>> index_set({1}) > index_set({2})
False
>>> index_set({1}) >= index_set({2})
False
>>> None == index_set({1,2})
False
>>> None != index_set({1,2})
True
>>> None < index_set({1,2})
False
>>> None <= index_set({1,2})
False
>>> None > index_set({1,2})
False
>>> None >= index_set({1,2})
False
>>> index_set({1,2}) == None
False
>>> index_set({1,2}) != None
True
>>> index_set({1,2}) < None
False
>>> index_set({1,2}) <= None
False
>>> index_set({1,2}) > None
False
>>> index_set({1,2}) >= None
False

Definition at line 406 of file PyClical.pyx.

istpq()

def PyClical.istpq	(		p,
			q
	)

Abbreviation for index_set({-q,...p}).

>>> print(istpq(2,3))
{-3,-2,-1,1,2}

Definition at line 1949 of file PyClical.pyx.

Variable Documentation

__version__

PyClical.__version__ = str(glucat_package_version,'utf-8')

private

Definition at line 35 of file PyClical.pyx.

cl

PyClical.cl = clifford

Definition at line 1910 of file PyClical.pyx.

Referenced by cga3.agc3(), cga3.cga3(), and cga3.cga3std().

fill

PyClical.fill

Definition at line 1864 of file PyClical.pyx.

Referenced by glucat::framed_multi< Scalar_T, LO, HI, Tune_P >.random(), and glucat::matrix_multi< Scalar_T, LO, HI, Tune_P >.random().

i

PyClical.i

Definition at line 1591 of file PyClical.pyx.

Referenced by glucat.acos(), glucat.acosh(), glucat.asin(), glucat.asinh(), glucat.atan(), glucat.atanh(), glucat.check_complex(), glucat.cos(), glucat.log(), glucat.matrix_log(), glucat.matrix_sqrt(), glucat.operator<<(), glucat.operator>>(), glucat.sin(), glucat.sqrt(), and glucat.tan().

ist

PyClical.ist = index_set

Definition at line 1928 of file PyClical.pyx.

Referenced by cga3.agc3(), glucat::matrix_multi< Scalar_T, LO, HI, Tune_P >.basis_element(), glucat::framed_multi< Scalar_T, LO, HI, Tune_P >.centre_pm4_qp4(), glucat::framed_multi< Scalar_T, LO, HI, Tune_P >.centre_pp4_qm4(), glucat::framed_multi< Scalar_T, LO, HI, Tune_P >.centre_qp1_pm1(), cga3.cga3(), cga3.cga3std(), glucat::framed_multi< Scalar_T, LO, HI, Tune_P >.divide(), glucat::framed_multi< Scalar_T, LO, HI, Tune_P >.framed_multi(), index_set_to_repr(), index_set_to_str(), glucat::matrix_multi< Scalar_T, LO, HI, Tune_P >.matrix_multi(), glucat.max_pos(), glucat.min_neg(), glucat.operator<<(), and glucat.operator>>().

ixt

PyClical.ixt

Definition at line 1864 of file PyClical.pyx.

lhs

PyClical.lhs

Definition at line 1359 of file PyClical.pyx.

Referenced by glucat.approx_equal(), glucat.crd_of_mult(), glucat.error_squared(), glucat::numeric_traits< Scalar_T >.fmod(), glucat::matrix.inner(), glucat::matrix.kron(), glucat::matrix.mono_kron(), glucat::matrix.mono_prod(), glucat::matrix.nork(), glucat.operator &(), glucat.operator!=(), glucat.operator%(), glucat.operator*(), glucat.operator+(), glucat.operator-(), glucat.operator/(), glucat.operator^(), glucat.operator|(), glucat.outer_pow(), glucat.pos_mod(), glucat.pow(), glucat::matrix.prod(), glucat.reframe(), glucat::matrix.signed_perm_nork(), glucat::matrix.sparse_prod(), and glucat.star().

nbar3

def PyClical.nbar3 = e(4) - e(-1)

Definition at line 1959 of file PyClical.pyx.

ninf3

def PyClical.ninf3 = e(4) + e(-1)

Definition at line 1958 of file PyClical.pyx.

Referenced by cga3.cga3(), and cga3.cga3std().

None

PyClical.None

Definition at line 1359 of file PyClical.pyx.

obj

PyClical.obj

Definition at line 1591 of file PyClical.pyx.

pi

float PyClical.pi = atan(clifford(1.0)) * 4.0

Definition at line 1907 of file PyClical.pyx.

Referenced by glucat::matrix.classify_eigenvalues(), glucat.cos(), glucat.log(), glucat.matrix_log(), and glucat.sin().

rhs

PyClical.rhs

Definition at line 1359 of file PyClical.pyx.

Referenced by glucat.approx_equal(), glucat.crd_of_mult(), glucat.error_squared(), glucat::numeric_traits< Scalar_T >.fmod(), glucat::matrix.inner(), glucat::matrix.kron(), glucat::index_set< LO, HI >.lex_less_than(), glucat::matrix.mono_kron(), glucat::matrix.mono_prod(), glucat::matrix.nork(), glucat::matrix.nork_range(), glucat.operator &(), glucat::index_set< LO, HI >.operator!=(), glucat.operator!=(), glucat.operator%(), glucat.operator*(), glucat::framed_multi< Scalar_T, LO, HI, Tune_P >::var_term.operator*=(), glucat.operator+(), glucat.operator-(), glucat.operator/(), glucat::index_set< LO, HI >.operator<(), glucat::matrix_multi< Scalar_T, LO, HI, Tune_P >.operator=(), glucat::index_set< LO, HI >.operator==(), glucat.operator^(), glucat::index_set< LO, HI >.operator^=(), glucat.operator|(), glucat::index_set< LO, HI >.operator|=(), glucat.outer_pow(), glucat.pos_mod(), glucat.pow(), glucat::matrix.prod(), glucat.reframe(), glucat::index_set< LO, HI >.sign_of_mult(), glucat::matrix.signed_perm_nork(), glucat::matrix.sparse_prod(), and glucat.star().

scalar_epsilon

PyClical.scalar_epsilon = epsilon

Definition at line 1905 of file PyClical.pyx.

tau

float PyClical.tau = atan(clifford(1.0)) * 8.0

Definition at line 1908 of file PyClical.pyx.

threshold

PyClical.threshold = error_squared_tol(rhs) if threshold is None else threshold

Definition at line 1359 of file PyClical.pyx.

Referenced by glucat.approx_equal(), and glucat.error_squared().

tol

PyClical.tol = error_squared_tol(rhs) if tol is None else tol

Definition at line 1359 of file PyClical.pyx.

Referenced by glucat.operator<<().