Package rdkit :: Package DataStructs :: Module cDataStructs :: Class UIntSparseIntVect

class UIntSparseIntVect

 object --+    
          |    
??.instance --+
              |
             UIntSparseIntVect

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

The length of the vector is set at construction time.

As you would expect, _SparseIntVects_ support a set of binary operations
so you can do things like:
  Arithmetic:
  siv1 += siv2
  siv3 = siv1 + siv2
  siv1 -= siv3
  siv3 = siv1 - siv2
  "Fuzzy" binary operations:
  siv3 = siv1 & siv2  the result contains the smallest value in each entry
  siv3 = siv1 | siv2  the result contains the largest value in each entry

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

Instance Methods

[hide private]

GetLength(...)
GetLength( (UIntSparseIntVect)arg1) -> int : Returns the length of the vector

GetNonzeroElements(...)
GetNonzeroElements( (UIntSparseIntVect)arg1) -> dict : returns a dictionary of the nonzero elements

GetTotalVal(...)
GetTotalVal( (UIntSparseIntVect)arg1 [, (bool)useAbs=False]) -> int : Get the sum of the values in the vector, basically L1 norm

ToBinary(...)
ToBinary( (UIntSparseIntVect)arg1) -> object : returns a binary (pickle) representation of the vector

UpdateFromSequence(...)
UpdateFromSequence( (UIntSparseIntVect)arg1, (AtomPairsParameters)arg2) -> None : update the vector based on the values in the list or tuple

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

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

__eq__(...)
__eq__( (UIntSparseIntVect)arg1, (UIntSparseIntVect)arg2) -> object :

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

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

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

__idiv__(...)
__idiv__( (object)arg1, (int)arg2) -> object :

__imul__(...)
__imul__( (object)arg1, (int)arg2) -> object :

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

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

__ne__(...)
__ne__( (UIntSparseIntVect)arg1, (UIntSparseIntVect)arg2) -> object :

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

__reduce__(...)

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

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

Inherited from unreachable.instance: __new__

Class Variables

[hide private]

__instance_size__ = 32

__safe_for_unpickling__ = True

Method Details

[hide private]

GetLength(...)


GetLength( (UIntSparseIntVect)arg1) -> int :
    Returns the length of the vector

    C++ signature :
        unsigned int GetLength(RDKit::SparseIntVect<unsigned int> {lvalue})

GetNonzeroElements(...)


GetNonzeroElements( (UIntSparseIntVect)arg1) -> dict :
    returns a dictionary of the nonzero elements

    C++ signature :
        boost::python::dict GetNonzeroElements(RDKit::SparseIntVect<unsigned int> {lvalue})

GetTotalVal(...)


GetTotalVal( (UIntSparseIntVect)arg1 [, (bool)useAbs=False]) -> int :
    Get the sum of the values in the vector, basically L1 norm

    C++ signature :
        int GetTotalVal(RDKit::SparseIntVect<unsigned int> {lvalue} [,bool=False])

ToBinary(...)


ToBinary( (UIntSparseIntVect)arg1) -> object :
    returns a binary (pickle) representation of the vector

    C++ signature :
        boost::python::api::object ToBinary(RDKit::SparseIntVect<unsigned int>)

UpdateFromSequence(...)


UpdateFromSequence( (UIntSparseIntVect)arg1, (AtomPairsParameters)arg2) -> None :
    update the vector based on the values in the list or tuple

    C++ signature :
        void UpdateFromSequence(RDKit::SparseIntVect<unsigned int> {lvalue},boost::python::api::object {lvalue})

add(...)
(Addition operator)


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

    C++ signature :
        _object* __add__(RDKit::SparseIntVect<unsigned int> {lvalue},RDKit::SparseIntVect<unsigned int>)

and(...)
(And operator)


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

    C++ signature :
        _object* __and__(RDKit::SparseIntVect<unsigned int> {lvalue},RDKit::SparseIntVect<unsigned int>)

eq(...)
(Equality operator)


__eq__( (UIntSparseIntVect)arg1, (UIntSparseIntVect)arg2) -> object :

    C++ signature :
        _object* __eq__(RDKit::SparseIntVect<unsigned int> {lvalue},RDKit::SparseIntVect<unsigned int>)

getinitargs(...)


__getinitargs__( (UIntSparseIntVect)arg1) -> tuple :

    C++ signature :
        boost::python::tuple __getinitargs__(RDKit::SparseIntVect<unsigned int>)

getitem(...)
(Indexing operator)


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

    C++ signature :
        int __getitem__(RDKit::SparseIntVect<unsigned int> {lvalue},unsigned int)

iadd(...)


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

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

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

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

idiv(...)


__idiv__( (object)arg1, (int)arg2) -> object :

    C++ signature :
        _object* __idiv__(boost::python::back_reference<RDKit::SparseIntVect<unsigned int>&>,int)

imul(...)


__imul__( (object)arg1, (int)arg2) -> object :

    C++ signature :
        _object* __imul__(boost::python::back_reference<RDKit::SparseIntVect<unsigned int>&>,int)

init(...)
(Constructor)


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

    C++ signature :
        void __init__(_object*,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, (UIntSparseIntVect)arg2) -> object :

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

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

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

ne(...)


__ne__( (UIntSparseIntVect)arg1, (UIntSparseIntVect)arg2) -> object :

    C++ signature :
        _object* __ne__(RDKit::SparseIntVect<unsigned int> {lvalue},RDKit::SparseIntVect<unsigned int>)

or(...)
(Or operator)


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

    C++ signature :
        _object* __or__(RDKit::SparseIntVect<unsigned int> {lvalue},RDKit::SparseIntVect<unsigned int>)

reduce(...)

Overrides: object.__reduce__: (inherited documentation)

setitem(...)
(Index assignment operator)


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

    C++ signature :
        void __setitem__(RDKit::SparseIntVect<unsigned int> {lvalue},unsigned int,int)

sub(...)
(Subtraction operator)


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

    C++ signature :
        _object* __sub__(RDKit::SparseIntVect<unsigned int> {lvalue},RDKit::SparseIntVect<unsigned int>)

class UIntSparseIntVect

GetLength(...)

GetNonzeroElements(...)

GetTotalVal(...)

ToBinary(...)

UpdateFromSequence(...)

__add__(...) (Addition operator)

__and__(...) (And operator)

__eq__(...) (Equality operator)

__getinitargs__(...)

__getitem__(...) (Indexing operator)

__iadd__(...)

__idiv__(...)

__imul__(...)

__init__(...) (Constructor)

__isub__(...)

__ne__(...)

__or__(...) (Or operator)

__reduce__(...)

__setitem__(...) (Index assignment operator)

__sub__(...) (Subtraction operator)

add(...)
(Addition operator)

and(...)
(And operator)

eq(...)
(Equality operator)

getinitargs(...)

getitem(...)
(Indexing operator)

iadd(...)

idiv(...)

imul(...)

init(...)
(Constructor)

isub(...)

ne(...)

or(...)
(Or operator)

reduce(...)

setitem(...)
(Index assignment operator)

sub(...)
(Subtraction operator)