cdsVector
index
/home/schwitrs/bzr-repo/xplor-python3/bin.Linux_x86_64/cdsVector.py

Numerical vector classes
 
  CDSVectors are container objects which behave much like Python
sequences: the [] operator behaves as expected, returning an
element or slice and the len() function returns the size of the
list. Note that a proper Python list is generated using the slice [:].
 
Linear algebraic functions (+*-) are also defined on CDSVector objects. 
 
Constructors:
 
  CDSVector_type(size[, initializer])
    where the vector size and an optional initializer value are specified.
 
  CDSVector_type(python_object)
    where python_object is a sequence whose elements are compatible with type.
 
  CDSVector_type(other_CDSVector_type)
    this is a copy constructor.
 
Classes:
 
CDSVector_double
  vector of floating point values. CDSVector_doubles may be multiplied
  by a cdsMatrix.RMat of the appropriate size.
 
CDSVector_Vec3
  vector of vec3.Vec3 objects.
 
CDSVector_int
  vector of integer values.
 
The following functions will act on CDSVector objects:
 
  sqrt(vec) - return a new CDSVector object each of whose elements is
              the sqrt of the correspondig argument of vec.
  log(vec)  - return a CDSVector whose elements are logrithms of the 
              corresponding elements of vec.
  vec_norm  - return a CDSVector_double whose elements are the norm of the 
              corresponding elements of vec.
  norm(vec) - return the norm of the entire vector.
  sum(vec)  - return the sum of the entire vector.
  min(vec)  - return the smallest element of the vector.
  max(vec)  - return the largest element of the vector.
  
miscellaneous members
  fromList(obj) - read a compatible Python object into the CDSVector.
  scale(x)      - scale each element by the value x.
  __pow__(x)    - raise each member to the x power (accessed via the ** 
                  operator). 
 
Note that mathematical operations which take element members out of
range are not supported. For instance, sqrt(CDSVector_int) is not
supported. 
 
 
 
# This file was automatically generated by SWIG (http://www.swig.org).
# Version 4.0.2
#
# Do not make changes to this file unless you know what you are doing--modify
# the SWIG interface file instead.

 
Classes
       
builtins.object
CDSVector_DComplex
CDSVector_Vec3
CDSVector_bool
CDSVector_double
CDSVector_int

 
class CDSVector_DComplex(builtins.object)
    CDSVector_DComplex(*args)
 

 
  Methods defined here:
__add__(self, *args) -> 'CDSVector< DComplex >'
__getitem__(self, *args, **kwargs)
__getslice__(self, *args, **kwargs) -> 'CDSVector< DComplex >'
__iadd__(self, *args) -> 'CDSVector< DComplex >'
__imul__(self, *args, **kwargs) -> 'CDSVector< DComplex >'
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__isub__(self, *args) -> 'CDSVector< DComplex >'
__itruediv__(self, *args, **kwargs) -> 'CDSVector< DComplex >'
__len__(self, *args, **kwargs) -> 'int'
__mul__(self, *args) -> 'CDSVector< DComplex >'
__neg__(self, *args, **kwargs) -> 'CDSVector< DComplex >'
__pow__(self, *args, **kwargs) -> 'CDSVector< DComplex >'
__radd__(self, *args, **kwargs) -> 'CDSVector< DComplex >'
__repr__ = _swig_repr(self)
__rmul__(self, *args, **kwargs) -> 'CDSVector< DComplex >'
__rsub__(self, *args, **kwargs) -> 'CDSVector< DComplex >'
__rtruediv__(self, *args, **kwargs) -> 'CDSVector< DComplex >'
__setitem__(self, *args, **kwargs) -> 'void'
__str__(self, *args, **kwargs) -> 'String'
Return str(self).
__sub__(self, *args) -> 'CDSVector< DComplex >'
__truediv__(self, *args) -> 'CDSVector< DComplex >'
fromList(s, l)
get(self, *args, **kwargs) -> 'DComplex'
help(self, *args, **kwargs) -> 'String'
resize(self, *args, **kwargs) -> 'void'
scale(self, *args, **kwargs) -> 'void'
set(self, *args, **kwargs) -> 'void'

Static methods defined here:
__swig_destroy__ = delete_CDSVector_DComplex(...)

Data descriptors defined here:
__dict__

 
dictionary for instance variables (if defined)
__weakref__

 
list of weak references to the object (if defined)
thisown

 
The membership flag

 
class CDSVector_Vec3(builtins.object)
    CDSVector_Vec3(*args)
 

 
  Methods defined here:
__add__(self, *args) -> 'CDSVector< Vec3 >'
__getitem__(self, *args, **kwargs)
__getslice__(self, *args, **kwargs) -> 'CDSVector< Vec3 >'
__iadd__(self, *args) -> 'CDSVector< Vec3 >'
__imul__(self, *args, **kwargs) -> 'CDSVector< Vec3 >'
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__isub__(self, *args) -> 'CDSVector< Vec3 >'
__itruediv__(self, *args, **kwargs) -> 'CDSVector< Vec3 >'
__len__(self, *args, **kwargs) -> 'int'
__mul__(self, *args) -> 'CDSVector< Vec3 >'
__neg__(self, *args, **kwargs) -> 'CDSVector< Vec3 >'
__pow__(self, *args, **kwargs) -> 'CDSVector< Vec3 >'
__radd__(self, *args, **kwargs) -> 'CDSVector< Vec3 >'
__repr__ = _swig_repr(self)
__rmul__(self, *args, **kwargs) -> 'CDSVector< Vec3 >'
__rsub__(self, *args, **kwargs) -> 'CDSVector< Vec3 >'
__rtruediv__(self, *args, **kwargs) -> 'CDSVector< Vec3 >'
__setitem__(self, *args, **kwargs) -> 'void'
__str__(self, *args, **kwargs) -> 'String'
Return str(self).
__sub__(self, *args) -> 'CDSVector< Vec3 >'
__truediv__(self, *args) -> 'CDSVector< Vec3 >'
fromList(s, l)
get(self, *args, **kwargs) -> 'Vec3'
help(self, *args, **kwargs) -> 'String'
resize(self, *args, **kwargs) -> 'void'
scale(self, *args, **kwargs) -> 'void'
set(self, *args, **kwargs) -> 'void'

Static methods defined here:
__swig_destroy__ = delete_CDSVector_Vec3(...)

Data descriptors defined here:
__dict__

 
dictionary for instance variables (if defined)
__weakref__

 
list of weak references to the object (if defined)
thisown

 
The membership flag

 
class CDSVector_bool(builtins.object)
    CDSVector_bool(*args)
 

 
  Methods defined here:
__add__(self, *args) -> 'CDSVector< bool >'
__getitem__(self, *args, **kwargs)
__getslice__(self, *args, **kwargs) -> 'CDSVector< bool >'
__iadd__(self, *args) -> 'CDSVector< bool >'
__imul__(self, *args, **kwargs) -> 'CDSVector< bool >'
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__isub__(self, *args) -> 'CDSVector< bool >'
__itruediv__(self, *args, **kwargs) -> 'CDSVector< bool >'
__len__(self, *args, **kwargs) -> 'int'
__mul__(self, *args) -> 'CDSVector< bool >'
__neg__(self, *args, **kwargs) -> 'CDSVector< bool >'
__pow__(self, *args, **kwargs) -> 'CDSVector< bool >'
__radd__(self, *args, **kwargs) -> 'CDSVector< bool >'
__repr__ = _swig_repr(self)
__rmul__(self, *args, **kwargs) -> 'CDSVector< bool >'
__rsub__(self, *args, **kwargs) -> 'CDSVector< bool >'
__rtruediv__(self, *args, **kwargs) -> 'CDSVector< bool >'
__setitem__(self, *args, **kwargs) -> 'void'
__str__(self, *args, **kwargs) -> 'String'
Return str(self).
__sub__(self, *args) -> 'CDSVector< bool >'
__truediv__(self, *args) -> 'CDSVector< bool >'
fromList(s, l)
get(self, *args, **kwargs) -> 'bool'
help(self, *args, **kwargs) -> 'String'
resize(self, *args, **kwargs) -> 'void'
scale(self, *args, **kwargs) -> 'void'
set(self, *args, **kwargs) -> 'void'

Static methods defined here:
__swig_destroy__ = delete_CDSVector_bool(...)

Data descriptors defined here:
__dict__

 
dictionary for instance variables (if defined)
__weakref__

 
list of weak references to the object (if defined)
thisown

 
The membership flag

 
class CDSVector_double(builtins.object)
    CDSVector_double(*args)
 

 
  Methods defined here:
__add__ = newadd(s, x)
__getitem__(self, *args, **kwargs)
__getslice__(self, *args, **kwargs) -> 'CDSVector< double >'
__iadd__(self, *args) -> 'CDSVector< double >'
__imul__(self, *args, **kwargs) -> 'CDSVector< double >'
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__isub__(self, *args) -> 'CDSVector< double >'
__itruediv__(self, *args, **kwargs) -> 'CDSVector< double >'
__len__(self, *args, **kwargs) -> 'int'
__mul__(self, *args) -> 'CDSVector< double >'
__neg__(self, *args, **kwargs) -> 'CDSVector< double >'
__pow__(self, *args, **kwargs) -> 'CDSVector< double >'
__radd__(self, *args, **kwargs) -> 'CDSVector< double >'
__repr__ = _swig_repr(self)
__rmul__(self, *args, **kwargs) -> 'CDSVector< double >'
__rsub__(self, *args, **kwargs) -> 'CDSVector< double >'
__rtruediv__(self, *args, **kwargs) -> 'CDSVector< double >'
__setitem__(self, *args, **kwargs) -> 'void'
__str__(self, *args, **kwargs) -> 'String'
Return str(self).
__sub__(self, *args) -> 'CDSVector< double >'
__truediv__(self, *args) -> 'CDSVector< double >'
fromList(s, l)
get(self, *args, **kwargs) -> 'double'
help(self, *args, **kwargs) -> 'String'
resize(self, *args, **kwargs) -> 'void'
scale(self, *args, **kwargs) -> 'void'
set(self, *args, **kwargs) -> 'void'

Static methods defined here:
__swig_destroy__ = delete_CDSVector_double(...)

Data descriptors defined here:
__dict__

 
dictionary for instance variables (if defined)
__weakref__

 
list of weak references to the object (if defined)
thisown

 
The membership flag

 
class CDSVector_int(builtins.object)
    CDSVector_int(*args)
 

 
  Methods defined here:
__add__(self, *args) -> 'CDSVector< int >'
__getitem__(self, *args, **kwargs)
__getslice__(self, *args, **kwargs) -> 'CDSVector< int >'
__iadd__(self, *args) -> 'CDSVector< int >'
__imul__(self, *args, **kwargs) -> 'CDSVector< int >'
__init__(self, *args)
Initialize self.  See help(type(self)) for accurate signature.
__isub__(self, *args) -> 'CDSVector< int >'
__itruediv__(self, *args, **kwargs) -> 'CDSVector< int >'
__len__(self, *args, **kwargs) -> 'int'
__mul__(self, *args) -> 'CDSVector< int >'
__neg__(self, *args, **kwargs) -> 'CDSVector< int >'
__pow__(self, *args, **kwargs) -> 'CDSVector< int >'
__radd__(self, *args, **kwargs) -> 'CDSVector< int >'
__repr__ = _swig_repr(self)
__rmul__(self, *args, **kwargs) -> 'CDSVector< int >'
__rsub__(self, *args, **kwargs) -> 'CDSVector< int >'
__rtruediv__(self, *args, **kwargs) -> 'CDSVector< int >'
__setitem__(self, *args, **kwargs) -> 'void'
__str__(self, *args, **kwargs) -> 'String'
Return str(self).
__sub__(self, *args) -> 'CDSVector< int >'
__truediv__(self, *args) -> 'CDSVector< int >'
fromList(s, l)
get(self, *args, **kwargs) -> 'int'
help(self, *args, **kwargs) -> 'String'
resize(self, *args, **kwargs) -> 'void'
scale(self, *args, **kwargs) -> 'void'
set(self, *args, **kwargs) -> 'void'

Static methods defined here:
__swig_destroy__ = delete_CDSVector_int(...)

Data descriptors defined here:
__dict__

 
dictionary for instance variables (if defined)
__weakref__

 
list of weak references to the object (if defined)
thisown

 
The membership flag

 
Functions
       
cat(*args) -> 'CDSVector< DComplex >'
cat3(*args) -> 'CDSVector< DComplex >'
cat4(*args) -> 'CDSVector< DComplex >'
dot(*args) -> 'int'
exp(*args, **kwargs) -> 'CDSVector< double >'
log(*args, **kwargs) -> 'CDSVector< double >'
max(*args) -> 'DComplex'
min(*args) -> 'DComplex'
newadd(s, x)
norm(*args, **kwargs) -> 'float_type'
oldadd = __add__(self, *args) -> 'CDSVector< double >'
pyXplorHelp(*args) -> 'String'
sort(*args, **kwargs) -> 'void'
sqrt(*args, **kwargs) -> 'CDSVector< double >'
sum(*args) -> 'DComplex'
vec_norm(*args, **kwargs) -> 'CDSVector< double >'