Package slimpy_base.api.functions.scalar_functions

functions that work on SLIMpy scalars More...

Classes
class	scalar_proxies
	class to help scalar used to prevent error on pickle function used instead of defineing functions in the module namespace More...
Functions
def	generate_new_scalar
	generate_new_scalar( one, other, func) -> scalar
def	scalar_operation
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	scalar_value
	retuns a number if scal is either a number of a SLIMpy scalar object
Variables
string	__copyright__
string	__license__
tuple	__env__ = InstanceManager( )
	The SLIMpy global environment.
list	__all__
	for * import

---

Detailed Description

functions that work on SLIMpy scalars

general scalar functions that work on SLIMpy scalar objects or python numbers

---

Function Documentation

def slimpy_base.api.functions.scalar_functions.generate_new_scalar	(		one,
			other,
			func
	)

generate_new_scalar( one, other, func) -> scalar

Definition at line 49 of file scalar_functions.py.

def slimpy_base.api.functions.scalar_functions.scalar_operation	(		one,
			other,
			func
	)

Definition at line 72 of file scalar_functions.py.

def slimpy_base.api.functions.scalar_functions.scalar_value

(

scal

)

retuns a number if scal is either a number of a SLIMpy scalar object

Definition at line 205 of file scalar_functions.py.

---

Variable Documentation

list __all__

Initial value:

[ "scalar_max",
           "scalar_min",
           "real_if_close",
           "scalar_value",
           "scalar_mean" ]

for * import

Definition at line 39 of file scalar_functions.py.

string __copyright__

Initial value:

"""
Copyright 2008 Sean Ross-Ross
"""

Definition at line 9 of file scalar_functions.py.

tuple __env__ = InstanceManager( )

The SLIMpy global environment.

Definition at line 36 of file scalar_functions.py.

string __license__

Initial value:

"""
This file is part of SLIMpy .

SLIMpy is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

SLIMpy is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with SLIMpy . If not, see <http://www.gnu.org/licenses/>.
"""

Definition at line 12 of file scalar_functions.py.