Package DataStructs :: Module cDataStructs :: Class DiscreteValueVect
[hide private]
[frames] | no frames]

Class DiscreteValueVect



 object --+    
          |    
??.instance --+
              |
             DiscreteValueVect

A container class for storing unsigned integer
values within a particular range.

The length of the vector and type of its elements (determines the maxium value
that can be stored) are both set at construction time.

As you would expect, _DiscreteValueVects_ support a set of binary operations
so you can do things like:
  dvv3 = dvv1 & dvv2  the result contains the smallest value in each entry
  dvv3 = dvv1 | dvv2  the result contains the largest value in each entry
  dvv1 += dvv2     values are truncated when necessary
  dvv3 = dvv1 + dvv2    values are truncated when necessary
  dvv1 -= dvv3    would-be negative values are set to zero
  dvv3 = dvv1 - dvv2    would-be negative values are set to zero

Elements can be set and read using indexing (i.e. bv[i] = 4 or val=bv[i])



Instance Methods [hide private]
 
GetTotalVal(...)
Get the sum of the values in the vector, basically L1 norm...
 
GetValueType(...)
Get the type of value stored in the vector...
 
__add__(...)
C++ signature:...
 
__and__(...)
C++ signature:...
 
__getinitargs__(...)
C++ signature:...
 
__getitem__(...)
Get the value at a specified location...
 
__iadd__(...)
C++ signature:...
 
__init__(...)
Constructor...
 
__isub__(...)
C++ signature:...
 
__len__(...)
Get the number of entries in the vector...
 
__or__(...)
C++ signature:...
 
__reduce__(...)
helper for pickle
 
__setitem__(...)
Set the value at a specified location...
 
__sub__(...)
C++ signature:...

Inherited from unreachable.instance: __new__

Inherited from object: __delattr__, __getattribute__, __hash__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables [hide private]
  __instance_size__ = 40
  __safe_for_unpickling__ = True
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

GetTotalVal(...)

 
Get the sum of the values in the vector, basically L1 norm
C++ signature:
    GetTotalVal(RDKit::DiscreteValueVect {lvalue}) -> unsigned int

GetValueType(...)

 
Get the type of value stored in the vector
C++ signature:
    GetValueType(RDKit::DiscreteValueVect {lvalue}) -> RDKit::DiscreteValueVect::DiscreteValueType

__add__(...)
(Addition operator)

 
C++ signature:
__add__(RDKit::DiscreteValueVect {lvalue}, RDKit::DiscreteValueVect) -> _object*

__and__(...)
(And operator)

 
C++ signature:
__and__(RDKit::DiscreteValueVect {lvalue}, RDKit::DiscreteValueVect) -> _object*

__getinitargs__(...)

 
C++ signature:
__getinitargs__(RDKit::DiscreteValueVect) -> boost::python::tuple

__getitem__(...)
(Indexing operator)

 
Get the value at a specified location
C++ signature:
    __getitem__(RDKit::DiscreteValueVect {lvalue}, unsigned int) -> unsigned int

__iadd__(...)

 
C++ signature:
__iadd__(boost::python::back_reference<RDKit::DiscreteValueVect&>, RDKit::DiscreteValueVect) -> _object*

__init__(...)
(Constructor)

 
Constructor
C++ signature:
    __init__(_object*, RDKit::DiscreteValueVect::DiscreteValueType, unsigned int) -> void*
C++ signature:
    __init__(_object*, std::string) -> void*

Overrides: object.__init__

__isub__(...)

 
C++ signature:
__isub__(boost::python::back_reference<RDKit::DiscreteValueVect&>, RDKit::DiscreteValueVect) -> _object*

__len__(...)
(Length operator)

 
Get the number of entries in the vector
C++ signature:
    __len__(RDKit::DiscreteValueVect {lvalue}) -> unsigned int

__or__(...)
(Or operator)

 
C++ signature:
__or__(RDKit::DiscreteValueVect {lvalue}, RDKit::DiscreteValueVect) -> _object*

__reduce__(...)

 
helper for pickle

Overrides: object.__reduce__
(inherited documentation)

__setitem__(...)
(Index assignment operator)

 
Set the value at a specified location
C++ signature:
    __setitem__(RDKit::DiscreteValueVect {lvalue}, unsigned int, unsigned int) -> void*

__sub__(...)
(Subtraction operator)

 
C++ signature:
__sub__(RDKit::DiscreteValueVect {lvalue}, RDKit::DiscreteValueVect) -> _object*