A slice vector holding bits. More...
#include <yatemath.h>
Additional Inherited Members | |
 Static Public Member Functions inherited from SliceVector< Obj > | |
| static unsigned int | objSize () |
| static unsigned int | size (unsigned int len) |
| Static Public Member Functions inherited from GenObject | |
| static void * | getObject (const String &name, const GenObject *obj) |
| static bool | getObjCounting () |
| static void | setObjCounting (bool enable) |
| static NamedCounter * | getObjCounter (const String &name, bool create=true) |
| static ObjList & | getObjCounters () |
| Protected Member Functions inherited from SliceVector< Obj > | |
| Obj * | end (Obj *start, unsigned int len) |
| const Obj * | end (const Obj *start, unsigned int len) const |
| bool | setData (Obj *data=0, unsigned int len=0, unsigned int maxLen=0) |
| bool | initStorage (unsigned int len, const Obj *data=0, unsigned int maxLen=0) |
| bool | initSlice (bool del, const SliceVector &other, unsigned int offs=0, unsigned int len=0) |
| Protected Attributes inherited from SliceVector< Obj > | |
| RefStorage * | m_storage |
| Obj * | m_data |
| unsigned int | m_length |
| unsigned int | m_maxLen |
Detailed Description
A slice vector holding bits.
This vector holds bit values using 1 byte. It implements methods operating on bits. NOTE: The array indexing operator allows setting invalid values (not 1 or 0). The pack/unpack methods are safe (they will handle non 0 values as bit 1). The comparison operators may fail for vectors containing values other than 0 or 1.
Constructor & Destructor Documentation
◆ BitVector() [1/5]
|
inline |
Constructor
Referenced by BitVector::slice(), and BitVector::tail().
◆ BitVector() [2/5]
Copy constructor. Builds a slice of another vector
- Parameters
-
other Original vector
◆ BitVector() [3/5]
Constructor. Build the vector storage
- Parameters
-
len Length of data maxLen Optional vector maximum length (it will be adjusted to be at least len)
◆ BitVector() [4/5]
Constructor. Builds a slice of another vector
- Parameters
-
other Original vector offs Offset in the original vector len The number of elements (0 to use all available from offset)
◆ BitVector() [5/5]
Constructor. Build from string bits
- Parameters
-
str String bits ('1' -> 1, else -> 0) maxLen Optional vector maximum length
Member Function Documentation
◆ appendTo()
Append bits to string
- Parameters
-
buf Destination string offs Optional starting index len The number of elements to be added (negative to add all)
- Returns
- Destination string address
Referenced by BitVector::toString().
◆ get()
| bool get | ( | FloatVector & | dest | ) | const |
Set float bit values from this vector (0 -> 0.0F, non 0 -> 1.0F). The destination vector will be resized to this vector's length
- Parameters
-
dest The destination vector
- Returns
- True on success, false if destination resize failed
◆ head() [1/2]
Retrieve vector head
- Parameters
-
dest Destination vector len The number of elements to retrieve
- Returns
- True on success, false on failure (not enough data in our vector)
References BitVector::slice().
◆ head() [2/2]
Retrieve vector head
- Parameters
-
len The number of elements to retrieve
- Returns
- A vector containing the first elements of this vector
References BitVector::slice().
◆ pack() [1/2]
| bool pack | ( | ByteVector & | dest | ) | const |
Pack bits into a ByteVector (LSB source to MSB in destination). MSB of first byte in destination will have the same value of the first bit in this vector. Remaining elements in destination are left untouched
- Parameters
-
dest Destination vector
- Returns
- True on success, false on failure (not enough space in destination vector)
◆ pack() [2/2]
Pack up to 64 bits, LSB-first (i.e. first bit goes to LSB in destination)
- Parameters
-
offs The start offset len The number of elements to be packed (-1 to pack all available). No more than 64 bits will be packed
- Returns
- The packed 64-bit value
◆ set()
| bool set | ( | const FloatVector & | input | ) |
Initializes this vector from float values (0.0F -> 0, non 0 -> 1). The vector will be resized to input length
- Parameters
-
input The input vector
- Returns
- True on success, false if resize failed
◆ setSlice()
Set a slice containing another vector
- Parameters
-
other Original vector offs Offset in the original vector len The number of elements (0 to use all available from offset)
- Returns
- True on success, false on failure
◆ slice() [1/2]
Set a slice of this vector to another one. The destination vector will be changed
- Parameters
-
dest Destination vector offs Offset in our vector len The number of elements (0 to use all available from offset)
- Returns
- True on success, false on failure (not enough data in our vector)
◆ slice() [2/2]
Retrieve a vector slice
- Parameters
-
offs Offset in our vector len The number of elements to retrieve
- Returns
- A vector containing the requested slice (empty if offset/length are invalid)
References BitVector::BitVector().
Referenced by BitVector::head(), and BitVector::head().
◆ tail() [1/2]
Retrieve vector tail (last elements)
- Parameters
-
len The number of elements to retrieve dest Destination vector
- Returns
- True on success, false on failure (not enough data in our vector)
References SliceVector< Obj >::length().
◆ tail() [2/2]
Retrieve vector tail (last elements)
- Parameters
-
len The number of elements to retrieve
- Returns
- A vector containing the last elements of this vector
References BitVector::BitVector(), and SliceVector< Obj >::length().
◆ toString()
Build a String from vector bits and return it
- Parameters
-
offs Optional starting index len The number of elements to be added (negative to add all)
- Returns
- A newly created String containing vector bits
References BitVector::appendTo(), and SliceVector< Obj >::SliceVector().
◆ unpack() [1/2]
| bool unpack | ( | const ByteVector & | src | ) |
Unpack a ByteVector into this BitVector. MSB of the first element in source goes to first bit in this vector. Remaining bits are left untouched
- Parameters
-
src Source byte vector
- Returns
- True on success, false if there is not enough space to unpack
◆ unpack() [2/2]
Unpack up to 64 bits into this vector, LSB first
- Parameters
-
value Value to unpack offs Optional start offset len The number of bits to unpack
◆ unpackMsb()
Unpack up to 32 bits into this vector (MSB to LSB). MSB from value is the first unpacked bit
- Parameters
-
value The value to be unpacked offs Optional start offset len The number of bits to unpack
Referenced by BitVector::unpackMsb16().
◆ unpackMsb16()
Unpack up to 16 bits into this vector (MSB to LSB). MSB from value is the first unpacked bit
- Parameters
-
value The value to be unpacked offs Optional start offset len The number of bits to unpack
References BitVector::unpackMsb().
◆ valid()
| bool valid | ( | ) | const |
Check if this vector contains valid values (0 or 1)
- Returns
- True on success, false if the vector contains values other than 0 or 1
◆ xorMsb()
Apply XOR on vector elements using a given value's bits, MSB first. Given v31,v30,...,v0 the value's bits in MSB order the result will be data()[offs] ^= v31, data()[offs+1] ^= v30 ...
- Parameters
-
value Value to use offs Start position in this BitVector len The number of bits to use
Referenced by BitVector::xorMsb16().
◆ xorMsb16()
Apply XOR on vector elements using a given value's bits, MSB first. Given v15,v14,...,v0 the value's bits in MSB order the result will be data()[offs] ^= v15, data()[offs+1] ^= v14 ...
- Parameters
-
value Value to use offs Start position in this BitVector len The number of bits to use
References BitVector::xorMsb().
The documentation for this class was generated from the following file:
