RDKit::DiscreteValueVect Class Reference

a class for efficiently storing vectors of discrete values More...

#include <DiscreteValueVect.h>

List of all members.

Public Types
enum	DiscreteValueType {   ONEBITVALUE = 0, TWOBITVALUE, FOURBITVALUE, EIGHTBITVALUE,   SIXTEENBITVALUE }
	used to define the possible range of the values More...
typedef boost::shared_array < boost::uint32_t >	DATA_SPTR
Public Member Functions
	DiscreteValueVect (DiscreteValueType valType, unsigned int length)
	initialize with a particular type and size
	DiscreteValueVect (const DiscreteValueVect &other)
	Copy constructor.
	DiscreteValueVect (const std::string pkl)
	constructor from a pickle
	DiscreteValueVect (const char *pkl, const unsigned int len)
	constructor from a pickle
	~DiscreteValueVect ()
unsigned int	getVal (unsigned int i) const
	return the value at an index
void	setVal (unsigned int i, unsigned int val)
	set the value at an index
unsigned int	getTotalVal () const
	returns the sum of all the elements in the vect
unsigned int	getLength () const
	returns the length
const boost::uint32_t *	getData () const
	return a pointer to our raw data storage
unsigned int	getNumBitsPerVal () const
	return the number of bits used to store each value
DiscreteValueType	getValueType () const
	return the type of value being stored
unsigned int	getNumInts () const
	returns the size of our storage
DiscreteValueVect	operator & (const DiscreteValueVect &other) const
	support dvv3 = dvv1&dvv2
DiscreteValueVect	operator| (const DiscreteValueVect &other) const
	support dvv3 = dvv1|dvv2
DiscreteValueVect &	operator+= (const DiscreteValueVect &other)
DiscreteValueVect &	operator-= (const DiscreteValueVect &other)
std::string	toString () const
	returns a binary string representation (pickle)

---

Detailed Description

a class for efficiently storing vectors of discrete values

Definition at line 19 of file DiscreteValueVect.h.

---

Member Typedef Documentation

typedef boost::shared_array<boost::uint32_t> RDKit::DiscreteValueVect::DATA_SPTR

Definition at line 21 of file DiscreteValueVect.h.

---

Member Enumeration Documentation

enum RDKit::DiscreteValueVect::DiscreteValueType

used to define the possible range of the values

Enumerator:

ONEBITVALUE
TWOBITVALUE
FOURBITVALUE
EIGHTBITVALUE
SIXTEENBITVALUE

Definition at line 24 of file DiscreteValueVect.h.

---

Constructor & Destructor Documentation

RDKit::DiscreteValueVect::DiscreteValueVect	(	DiscreteValueType	valType,
		unsigned int	length
	)			[inline]

initialize with a particular type and size

Definition at line 33 of file DiscreteValueVect.h.

References RDKit::BITS_PER_INT.

RDKit::DiscreteValueVect::DiscreteValueVect

(

const DiscreteValueVect &

other

)

Copy constructor.

RDKit::DiscreteValueVect::DiscreteValueVect

(

const std::string

pkl

)

[inline]

constructor from a pickle

Definition at line 47 of file DiscreteValueVect.h.

RDKit::DiscreteValueVect::DiscreteValueVect	(	const char *	pkl,
		const unsigned int	len
	)			[inline]

constructor from a pickle

Definition at line 51 of file DiscreteValueVect.h.

RDKit::DiscreteValueVect::~DiscreteValueVect

(

)

[inline]

Definition at line 55 of file DiscreteValueVect.h.

---

Member Function Documentation

unsigned int RDKit::DiscreteValueVect::getVal

(

unsigned int

i

)

const

return the value at an index

void RDKit::DiscreteValueVect::setVal	(	unsigned int	i,
		unsigned int	val
	)

set the value at an index

NOTE: it is an error to have val > the max value this DiscreteValueVect can accomodate

unsigned int RDKit::DiscreteValueVect::getTotalVal

(

)

const

returns the sum of all the elements in the vect

unsigned int RDKit::DiscreteValueVect::getLength

(

)

const

returns the length

const boost::uint32_t* RDKit::DiscreteValueVect::getData

(

)

const

return a pointer to our raw data storage

unsigned int RDKit::DiscreteValueVect::getNumBitsPerVal

(

)

const [inline]

return the number of bits used to store each value

Definition at line 76 of file DiscreteValueVect.h.

DiscreteValueType RDKit::DiscreteValueVect::getValueType

(

)

const [inline]

return the type of value being stored

Definition at line 81 of file DiscreteValueVect.h.

Referenced by RDGeom::UniformGrid3D::operator &().

unsigned int RDKit::DiscreteValueVect::getNumInts

(

)

const [inline]

returns the size of our storage

Definition at line 86 of file DiscreteValueVect.h.

DiscreteValueVect RDKit::DiscreteValueVect::operator &

(

const DiscreteValueVect &

other

)

const

support dvv3 = dvv1&dvv2

operator& returns the minimum value for each element. e.g.: [0,1,2,0] & [0,1,1,1] -> [0,1,1,0]

DiscreteValueVect RDKit::DiscreteValueVect::operator|

(

const DiscreteValueVect &

other

)

const

support dvv3 = dvv1|dvv2

operator& returns the maximum value for each element. e.g.: [0,1,2,0] | [0,1,1,1] -> [0,1,2,1]

DiscreteValueVect& RDKit::DiscreteValueVect::operator+=

(

const DiscreteValueVect &

other

)

DiscreteValueVect& RDKit::DiscreteValueVect::operator-=

(

const DiscreteValueVect &

other

)

std::string RDKit::DiscreteValueVect::toString

(

)

const

returns a binary string representation (pickle)

---

The documentation for this class was generated from the following file:

• DiscreteValueVect.h