user functions

Functions in this group are generaly related to slimpy_base.Core.User.Structures.serial_vector.Vector and slimpy_base.Core.User.Structures.Scalar.Scalar objects. More...

Functions
def	cmplx
	create a complex vector from real and imaginary parts
def	cat
	Concatenate datasets.
def	clnorm
	norm of coloums of fdct2
def	scalar_max
	return max element
def	scalar_min
	return min element
def	real_if_close
	returns a real valued scalar if imaginary part of scal is close to 0
def	scalar_mean
	mean value of a sequence of scalars
def	equal
	Test if two vectors are equal per element.
def	not_equal
	Test if two vectors are not equal per element.
def	less_than
	Test if elements of vec1 are less than vec2.
def	less_than_eq
	Test if elements of vec1 are less than or equal to vec2.
def	greater_than
	Test if elements of vec1 are greater than vec2.
def	greater_than_eq
	Test if elements of vec1 are greater than or equal to vec2.
def	or_
	Test if elements of either vec1 or vec2 are non-zero.
def	and_
	Test if elements of both vec1 or vec2 are non-zero.
def	inner_product
	inner product of two vectors
def	outer_product
	Outer product of two vectors.
def	shelp
	interactive help for SLIMpy

---

Detailed Description

Functions in this group are generaly related to slimpy_base.Core.User.Structures.serial_vector.Vector and slimpy_base.Core.User.Structures.Scalar.Scalar objects.

---

Function Documentation

def slimpy_base.api.functions.spboolean.and_	(		vec1,
			vec2,
			eps = 0
	)

Test if elements of both vec1 or vec2 are non-zero.

Parameters:

	vec1	a vector
	vec2	a vector
	eps	a number

Precondition:

vec1 and vec2 are the same length

Returns:

: a vector of integers the same length as input. and_( vec1 , vec2 , eps=0 ) -> vec3

Test if elements of either vec1 or vec2 are non-zero

Definition at line 189 of file spboolean.py.

def slimpy_base.api.functions.functions.cat	(		catlist,
			axis
	)

Concatenate datasets.

Parameters:

	catlist	a list that contains the vectors to be concatonated
	axis	Axis being merged

Returns:

: a vector Concatenate datasets catlist in the axis dinention. cat( axis, catlist ) -> vector

Definition at line 69 of file functions.py.

def slimpy_base.api.functions.functions.clnorm	(		A,
			mode = "norm",
			angconstr = [0
	)

norm of coloums of fdct2

Parameters:

	A	the fdct2 linear operator
	mode	todo
	angconstr	todo

Returns:

: a diagonal weight linear operator clnorm( A ,mode="norm" , angconstr=[0,0] ) -> DiagonalWeight retruns a diagonal weight operator with domain and range in the vector space of the domain of A The weight coresponds to the norms of the coloums of A

Definition at line 99 of file functions.py.

def slimpy_base.api.functions.functions.cmplx	(		real,
			imag
	)

create a complex vector from real and imaginary parts

Parameters:

	real	a vector that contains real numers
	imag	a vector that contains real numers

Returns:

: a complex vector that is composed of real numbers for param real and imaginary numbers from param imag cmplx( real, imag ) -> complex vector create a complex vector from real and imaginary parts

Definition at line 50 of file functions.py.

def slimpy_base.api.functions.spboolean.equal	(		vec1,
			vec2,
			eps = 0
	)

Test if two vectors are equal per element.

Parameters:

	vec1	a vector
	vec2	a vector
	eps	a number

Precondition:

vec1 and vec2 are the same length

Returns:

: a vector of integers the same length as input. equal( vec1 , vec2 , eps=0 ) -> vec3

Test if two vectors elemnts are equal within eps precision

Definition at line 44 of file spboolean.py.

def slimpy_base.api.functions.spboolean.greater_than	(		vec1,
			vec2,
			eps = 0
	)

Test if elements of vec1 are greater than vec2.

Parameters:

	vec1	a vector
	vec2	a vector
	eps	a number

Precondition:

vec1 and vec2 are the same length

Returns:

: a vector of integers the same length as input. greater_than( vec1 , vec2 , eps=0 ) -> vec3

Test if two vectors elemnts are greater than vec2

Definition at line 129 of file spboolean.py.

def slimpy_base.api.functions.spboolean.greater_than_eq	(		vec1,
			vec2,
			eps = 0
	)

Test if elements of vec1 are greater than or equal to vec2.

Parameters:

	vec1	a vector
	vec2	a vector
	eps	a number

Precondition:

vec1 and vec2 are the same length

Returns:

: a vector of integers the same length as input. greater_than_eq( vec1 , vec2 , eps=0 ) -> vec3

Test if two vectors elemnts are greater than or equal to vec2

Definition at line 149 of file spboolean.py.

def slimpy_base.api.functions.vector_product.inner_product	(		vec1,
			vec2
	)

inner product of two vectors

Parameters:

	vec1	a vector
	vec2	a vector

Precondition:

vec1 and vec2 are the same length

Returns:

: a scalar

inner_product( vec1, vec2 ) -> scalar take the inner product of two vectors

Definition at line 38 of file vector_product.py.

def slimpy_base.api.functions.spboolean.less_than	(		vec1,
			vec2,
			eps = 0
	)

Test if elements of vec1 are less than vec2.

Parameters:

	vec1	a vector
	vec2	a vector
	eps	a number

Precondition:

vec1 and vec2 are the same length

Returns:

: a vector of integers the same length as input. less_than( vec1 , vec2 , eps=0 ) -> vec3

Test if two vectors elemnts are less than vec2

Definition at line 87 of file spboolean.py.

def slimpy_base.api.functions.spboolean.less_than_eq	(		vec1,
			vec2,
			eps = 0
	)

Test if elements of vec1 are less than or equal to vec2.

Parameters:

	vec1	a vector
	vec2	a vector
	eps	a number

Precondition:

vec1 and vec2 are the same length

Returns:

: a vector of integers the same length as input. less_than_eq( vec1 , vec2 , eps=0 ) -> vec3

Test if two vectors elemnts are less than or equal to vec2

Definition at line 108 of file spboolean.py.

def slimpy_base.api.functions.spboolean.not_equal	(		vec1,
			vec2,
			eps = 0
	)

Test if two vectors are not equal per element.

Parameters:

	vec1	a vector
	vec2	a vector
	eps	a number

Precondition:

vec1 and vec2 are the same length

Returns:

: a vector of integers the same length as input. not_equal( vec1 , vec2 , eps=0 ) -> vec3

Test if two vectors elemnts are not equal within eps precision

Definition at line 66 of file spboolean.py.

def slimpy_base.api.functions.spboolean.or_	(		vec1,
			vec2,
			eps = 0
	)

Test if elements of either vec1 or vec2 are non-zero.

Parameters:

	vec1	a vector
	vec2	a vector
	eps	a number

Precondition:

vec1 and vec2 are the same length

Returns:

: a vector of integers the same length as input. or_( vec1 , vec2 , eps=0 ) -> vec3

Test if elements of either vec1 or vec2 are non-zero

Definition at line 169 of file spboolean.py.

def slimpy_base.api.functions.vector_product.outer_product	(		vec1,
			vec2
	)

Outer product of two vectors.

Parameters:

	vec1	a vector
	vec2	a vector

Precondition:

vec1 and vec2 are the same length

Warning:

not implemented

Returns:

: a scalar

inner_product( vec1, vec2 ) -> scalar take the inner product of two vectors

Definition at line 64 of file vector_product.py.

def slimpy_base.api.functions.scalar_functions.real_if_close

(

scal

)

returns a real valued scalar if imaginary part of scal is close to 0

Parameters:

scal

a saclar object

Returns:

: a scalar object returns a real valued scalar if imaginary part of scal is close to 0 real_if_close( scal ) -> value

Definition at line 175 of file scalar_functions.py.

def slimpy_base.api.functions.scalar_functions.scalar_max

(

sequence

)

return max element

Parameters:

sequence

a sequence of scalars

Returns:

: a scalar object scalar_max(sequence) -> value scalar_max(a, b, c, ...) -> value

With a single sequence argument, return its largest item. With two or more arguments, return the largest argument.

Definition at line 129 of file scalar_functions.py.

def slimpy_base.api.functions.scalar_functions.scalar_mean

(

sequence

)

mean value of a sequence of scalars

Parameters:

sequence

a sequence of numbers

Returns:

: a scalar object scalar_mean( sequence ) -> value returns the mean value of sequence

Definition at line 188 of file scalar_functions.py.

def slimpy_base.api.functions.scalar_functions.scalar_min

(

sequence

)

return min element

Parameters:

sequence

a sequence of scalars

Returns:

: a scalar object scalar_min(sequence) -> value scalar_min(a, b, c, ...) -> value

With a single sequence argument, return its smallest item. With two or more arguments, return the smallest argument.

Definition at line 156 of file scalar_functions.py.

def slimpy_base.shelp.shelp

(

names

)

interactive help for SLIMpy

Parameters:

names

get help for objects

some other useful helper functions: listLinop() -> prints a list of all the linear operator classes listPlugins() -> print the plugins available ( ie. rsf ) printglobal() -> prints all global variables in 'slimvars'

Definition at line 40 of file shelp.py.