Package rdkit :: Package DataStructs :: Module cDataStructs :: Class DiscreteValueVect

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(...)
GetTotalVal( (DiscreteValueVect)arg1) -> int : Get the sum of the values in the vector, basically L1 norm

GetValueType(...)
GetValueType( (DiscreteValueVect)arg1) -> DiscreteValueType : Get the type of value stored in the vector

__add__(...)
__add__( (DiscreteValueVect)arg1, (DiscreteValueVect)arg2) -> object :

__and__(...)
__and__( (DiscreteValueVect)arg1, (DiscreteValueVect)arg2) -> object :

__getinitargs__(...)
__getinitargs__( (DiscreteValueVect)arg1) -> tuple :

__getitem__(...)
__getitem__( (DiscreteValueVect)arg1, (int)arg2) -> int : Get the value at a specified location

__iadd__(...)
__iadd__( (object)arg1, (DiscreteValueVect)arg2) -> object :

__init__(...)
__init__( (object)arg1, (DiscreteValueType)arg2, (int)arg3) -> None : Constructor

__isub__(...)
__isub__( (object)arg1, (DiscreteValueVect)arg2) -> object :

__len__(...)
__len__( (DiscreteValueVect)arg1) -> int : Get the number of entries in the vector

__or__(...)
__or__( (DiscreteValueVect)arg1, (DiscreteValueVect)arg2) -> object :

__reduce__(...)

__setitem__(...)
__setitem__( (DiscreteValueVect)arg1, (int)arg2, (int)arg3) -> None : Set the value at a specified location

__sub__(...)
__sub__( (DiscreteValueVect)arg1, (DiscreteValueVect)arg2) -> object :

Inherited from unreachable.instance: __new__

Class Variables

[hide private]

__instance_size__ = 56

__safe_for_unpickling__ = True

Method Details

[hide private]

GetTotalVal(...)


GetTotalVal( (DiscreteValueVect)arg1) -> int :
    Get the sum of the values in the vector, basically L1 norm

    C++ signature :
        unsigned int GetTotalVal(RDKit::DiscreteValueVect {lvalue})

GetValueType(...)


GetValueType( (DiscreteValueVect)arg1) -> DiscreteValueType :
    Get the type of value stored in the vector

    C++ signature :
        RDKit::DiscreteValueVect::DiscreteValueType GetValueType(RDKit::DiscreteValueVect {lvalue})

add(...)
(Addition operator)


__add__( (DiscreteValueVect)arg1, (DiscreteValueVect)arg2) -> object :

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

and(...)
(And operator)


__and__( (DiscreteValueVect)arg1, (DiscreteValueVect)arg2) -> object :

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

getinitargs(...)


__getinitargs__( (DiscreteValueVect)arg1) -> tuple :

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

getitem(...)
(Indexing operator)


__getitem__( (DiscreteValueVect)arg1, (int)arg2) -> int :
    Get the value at a specified location

    C++ signature :
        unsigned int __getitem__(RDKit::DiscreteValueVect {lvalue},unsigned int)

iadd(...)


__iadd__( (object)arg1, (DiscreteValueVect)arg2) -> object :

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

init(...)
(Constructor)


__init__( (object)arg1, (DiscreteValueType)arg2, (int)arg3) -> None :
    Constructor

    C++ signature :
        void __init__(_object*,RDKit::DiscreteValueVect::DiscreteValueType,unsigned int)

__init__( (object)arg1, (str)arg2) -> None :

    C++ signature :
        void __init__(_object*,std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> >)

Overrides: object.__init__

isub(...)


__isub__( (object)arg1, (DiscreteValueVect)arg2) -> object :

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

len(...)
(Length operator)


__len__( (DiscreteValueVect)arg1) -> int :
    Get the number of entries in the vector

    C++ signature :
        unsigned int __len__(RDKit::DiscreteValueVect {lvalue})

or(...)
(Or operator)


__or__( (DiscreteValueVect)arg1, (DiscreteValueVect)arg2) -> object :

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

reduce(...)

Overrides: object.__reduce__: (inherited documentation)

setitem(...)
(Index assignment operator)


__setitem__( (DiscreteValueVect)arg1, (int)arg2, (int)arg3) -> None :
    Set the value at a specified location

    C++ signature :
        void __setitem__(RDKit::DiscreteValueVect {lvalue},unsigned int,unsigned int)

sub(...)
(Subtraction operator)


__sub__( (DiscreteValueVect)arg1, (DiscreteValueVect)arg2) -> object :

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

class DiscreteValueVect

GetTotalVal(...)

GetValueType(...)

__add__(...) (Addition operator)

__and__(...) (And operator)

__getinitargs__(...)

__getitem__(...) (Indexing operator)

__iadd__(...)

__init__(...) (Constructor)

__isub__(...)

__len__(...) (Length operator)

__or__(...) (Or operator)

__reduce__(...)

__setitem__(...) (Index assignment operator)

__sub__(...) (Subtraction operator)

add(...)
(Addition operator)

and(...)
(And operator)

getinitargs(...)

getitem(...)
(Indexing operator)

iadd(...)

init(...)
(Constructor)

isub(...)

len(...)
(Length operator)

or(...)
(Or operator)

reduce(...)

setitem(...)
(Index assignment operator)

sub(...)
(Subtraction operator)