DataStructs.cDataStructs.ULongSparseIntVect

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

# Class ULongSparseIntVect

     object --+
              |
    ??.instance --+
                  |
                 ULongSparseIntVect

    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([ (ULongSparseIntVect)useAbs=False]) -> int :... |
GetNonzeroElements(...) GetNonzeroElements( (ULongSparseIntVect)arg1) -> dict :... |
GetTotalVal(...) GetTotalVal([ (ULongSparseIntVect)useAbs=False]) -> int :... |
ToBinary(...) ToBinary( (ULongSparseIntVect)arg1) -> str :... |
UpdateFromSequence(...) UpdateFromSequence( (ULongSparseIntVect)arg1, (AtomPairsParameters)arg2) -> None :... |
__add__(...) __add__( (ULongSparseIntVect)arg1, (ULongSparseIntVect)arg2) -> object :... |
__and__(...) __and__( (ULongSparseIntVect)arg1, (ULongSparseIntVect)arg2) -> object :... |
__eq__(...) __eq__( (ULongSparseIntVect)arg1, (ULongSparseIntVect)arg2) -> object :... |
__getinitargs__(...) __getinitargs__( (ULongSparseIntVect)arg1) -> tuple :... |
__getitem__(...) __getitem__( (ULongSparseIntVect)arg1, (int)arg2) -> int :... |
__iadd__(...) __iadd__( (object)arg1, (ULongSparseIntVect)arg2) -> object :... |
__init__(...) __init__( (object)arg1, (int)arg2) -> None :... |
__isub__(...) __isub__( (object)arg1, (ULongSparseIntVect)arg2) -> object :... |
__ne__(...) __ne__( (ULongSparseIntVect)arg1, (ULongSparseIntVect)arg2) -> object :... |
__or__(...) __or__( (ULongSparseIntVect)arg1, (ULongSparseIntVect)arg2) -> object :... |
__reduce__(...) helper for pickle |
__setitem__(...) __setitem__( (ULongSparseIntVect)arg1, (int)arg2, (int)arg3) -> None :... |
__sub__(...) __sub__( (ULongSparseIntVect)arg1, (ULongSparseIntVect)arg2) -> object :... |
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]

### GetLength(...) |
    GetLength([  (ULongSparseIntVect)useAbs=False]) -> int :
        Returns the length of the vector

        C++ signature :
            unsigned long long GetLength([ RDKit::SparseIntVect<unsigned long long> {lvalue}=False])

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

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

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

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

### ToBinary(...) |
    ToBinary( (ULongSparseIntVect)arg1) -> str :
        returns a binary (pickle) representation of the vector

        C++ signature :
            std::string ToBinary(RDKit::SparseIntVect<unsigned long long> {lvalue})

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

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

### __add__(...) (Addition operator) |
    __add__( (ULongSparseIntVect)arg1, (ULongSparseIntVect)arg2) -> object :

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

### __and__(...) (And operator) |
    __and__( (ULongSparseIntVect)arg1, (ULongSparseIntVect)arg2) -> object :

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

### __eq__(...) (Equality operator) |
    __eq__( (ULongSparseIntVect)arg1, (ULongSparseIntVect)arg2) -> object :

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

### __getinitargs__(...) |
    __getinitargs__( (ULongSparseIntVect)arg1) -> tuple :

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

### __getitem__(...) (Indexing operator) |
    __getitem__( (ULongSparseIntVect)arg1, (int)arg2) -> int :
        Get the value at a specified location

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

### __iadd__(...) |
    __iadd__( (object)arg1, (ULongSparseIntVect)arg2) -> object :

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

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

        C++ signature :
            void __init__(_object*,unsigned long long)

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

        C++ signature :
            void __init__(_object*,std::string)
Overrides: object.__init__

### __isub__(...) |
    __isub__( (object)arg1, (ULongSparseIntVect)arg2) -> object :

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

### __ne__(...) |
    __ne__( (ULongSparseIntVect)arg1, (ULongSparseIntVect)arg2) -> object :

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

### __or__(...) (Or operator) |
    __or__( (ULongSparseIntVect)arg1, (ULongSparseIntVect)arg2) -> object :

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

### __reduce__(...) |
    helper for pickle
Overrides: object.__reduce__ (inherited documentation)

### __setitem__(...) (Index assignment operator) |
    __setitem__( (ULongSparseIntVect)arg1, (int)arg2, (int)arg3) -> None :
        Set the value at a specified location

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

### __sub__(...) (Subtraction operator) |
    __sub__( (ULongSparseIntVect)arg1, (ULongSparseIntVect)arg2) -> object :

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