#include <src/main/decaf/internal/nio/FloatArrayBuffer.h>
Public Member Functions | |||||||||
| FloatArrayBuffer (int size, bool readOnly=false) | |||||||||
| Creates a FloatArrayBuffer object that has its backing array allocated internally and is then owned and deleted when this object is deleted. | |||||||||
| FloatArrayBuffer (float *array, int size, int offset, int length, bool readOnly=false) | |||||||||
| Creates a FloatArrayBuffer object that wraps the given array. | |||||||||
| FloatArrayBuffer (const decaf::lang::Pointer< ByteArrayAdapter > &array, int offset, int capacity, bool readOnly=false) | |||||||||
| Creates a byte buffer that wraps the passed ByteArrayAdapter and start at the given offset. | |||||||||
| FloatArrayBuffer (const FloatArrayBuffer &other) | |||||||||
| Create a FloatArrayBuffer that mirrors this one, meaning it shares a reference to this buffers ByteArrayAdapter and when changes are made to that data it is reflected in both. | |||||||||
| virtual | ~FloatArrayBuffer () | ||||||||
| virtual float * | array () | ||||||||
Returns the float array that backs this buffer (optional operation).Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa.Invoke the hasArray method before invoking this method in order to ensure that this buffer has an accessible backing array.
| |||||||||
| virtual int | arrayOffset () | ||||||||
Returns the offset within this buffer's backing array of the first element of the buffer (optional operation).Invoke the hasArray method before invoking this method in order to ensure that this buffer has an accessible backing array.
| |||||||||
| virtual FloatBuffer * | asReadOnlyBuffer () const | ||||||||
Creates a new, read-only float buffer that shares this buffer's content.The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer; the new buffer itself, however, will be read-only and will not allow the shared content to be modified. The two buffers' position, limit, and mark values will be independent.If this buffer is itself read-only then this method behaves in exactly the same way as the duplicate method.The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer.
| |||||||||
| virtual FloatBuffer & | compact () | ||||||||
Compacts this buffer.The bytes between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the byte at index p = position() is copied to index zero, the byte at index p + 1 is copied to index one, and so forth until the byte at index limit() - 1 is copied to index n = limit() - 1 - p. The buffer's position is then set to n+1 and its limit is set to its capacity. The mark, if defined, is discarded.The buffer's position is set to the number of bytes copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method.
| |||||||||
| virtual FloatBuffer * | duplicate () | ||||||||
Creates a new float buffer that shares this buffer's content.The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer. The new buffer will be read-only if, and only if, this buffer is read-only.
| |||||||||
| virtual float | get () | ||||||||
Relative get method.Reads the value at this buffer's current position, and then increments the position.
| |||||||||
| virtual float | get (int index) const | ||||||||
Absolute get method.Reads the value at the given index.
| |||||||||
| virtual bool | hasArray () const | ||||||||
Tells whether or not this buffer is backed by an accessible float array.If this method returns true then the array and arrayOffset methods may safely be invoked. Subclasses should override this method if they do not have a backing array as this class always returns true.
| |||||||||
| virtual bool | isReadOnly () const | ||||||||
Tells whether or not this buffer is read-only.
| |||||||||
| virtual FloatBuffer & | put (float value) | ||||||||
Writes the given floats into this buffer at the current position, and then increments the position.
| |||||||||
| virtual FloatBuffer & | put (int index, float value) | ||||||||
Writes the given floats into this buffer at the given index.
| |||||||||
| virtual FloatBuffer * | slice () const | ||||||||
Creates a new FloatBuffer whose content is a shared subsequence of this buffer's content.The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer, and its mark will be undefined. The new buffer will be read-only if, and only if, this buffer is read-only.
| |||||||||
| Public Member Functions inherited from decaf::nio::FloatBuffer | |||||||||
| virtual | ~FloatBuffer () | ||||||||
| virtual std::string | toString () const | ||||||||
| FloatBuffer & | get (std::vector< float > buffer) | ||||||||
| Relative bulk get method. | |||||||||
| FloatBuffer & | get (float *buffer, int size, int offset, int length) | ||||||||
| Relative bulk get method. | |||||||||
| FloatBuffer & | put (FloatBuffer &src) | ||||||||
| This method transfers the floats remaining in the given source buffer into this buffer. | |||||||||
| FloatBuffer & | put (const float *buffer, int size, int offset, int length) | ||||||||
| This method transfers floats into this buffer from the given source array. | |||||||||
| FloatBuffer & | put (std::vector< float > &buffer) | ||||||||
| This method transfers the entire content of the given source floats array into this buffer. | |||||||||
| virtual int | compareTo (const FloatBuffer &value) const | ||||||||
| virtual bool | equals (const FloatBuffer &value) const | ||||||||
| virtual bool | operator== (const FloatBuffer &value) const | ||||||||
| virtual bool | operator< (const FloatBuffer &value) const | ||||||||
| Public Member Functions inherited from decaf::nio::Buffer | |||||||||
| Buffer (int capactiy) | |||||||||
| Buffer (const Buffer &other) | |||||||||
| virtual | ~Buffer () | ||||||||
| virtual int | capacity () const | ||||||||
| virtual int | position () const | ||||||||
| virtual Buffer & | position (int newPosition) | ||||||||
| Sets this buffer's position. | |||||||||
| virtual int | limit () const | ||||||||
| virtual Buffer & | limit (int newLimit) | ||||||||
| Sets this buffer's limit. | |||||||||
| virtual Buffer & | mark () | ||||||||
| Sets this buffer's mark at its position. | |||||||||
| virtual Buffer & | reset () | ||||||||
| Resets this buffer's position to the previously-marked position. | |||||||||
| virtual Buffer & | clear () | ||||||||
| Clears this buffer. | |||||||||
| virtual Buffer & | flip () | ||||||||
| Flips this buffer. | |||||||||
| virtual Buffer & | rewind () | ||||||||
| Rewinds this buffer. | |||||||||
| virtual int | remaining () const | ||||||||
| Returns the number of elements between the current position and the limit. | |||||||||
| virtual bool | hasRemaining () const | ||||||||
| Tells whether there are any elements between the current position and the limit. | |||||||||
| Public Member Functions inherited from decaf::lang::Comparable< FloatBuffer > | |||||||||
| virtual | ~Comparable () | ||||||||
| virtual int | compareTo (const FloatBuffer &value) const=0 | ||||||||
| Compares this object with the specified object for order. | |||||||||
| virtual bool | equals (const FloatBuffer &value) const=0 | ||||||||
| virtual bool | operator== (const FloatBuffer &value) const=0 | ||||||||
| Compares equality between this object and the one passed. | |||||||||
| virtual bool | operator< (const FloatBuffer &value) const=0 | ||||||||
| Compares this object to another and returns true if this object is considered to be less than the one passed. | |||||||||
Protected Member Functions | |
| virtual void | setReadOnly (bool value) |
| Sets this FloatArrayBuffer as Read-Only. | |
| Protected Member Functions inherited from decaf::nio::FloatBuffer | |
| FloatBuffer (int capacity) | |
| Creates a FloatBuffer object that has its backing array allocated internally and is then owned and deleted when this object is deleted. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from decaf::nio::FloatBuffer | |
| static FloatBuffer * | allocate (int capacity) |
| Allocates a new Double buffer. | |
| static FloatBuffer * | wrap (float *array, int size, int offset, int length) |
| Wraps the passed buffer with a new FloatBuffer. | |
| static FloatBuffer * | wrap (std::vector< float > &buffer) |
| Wraps the passed STL float Vector in a FloatBuffer. | |
| Protected Attributes inherited from decaf::nio::Buffer | |
| int | _position |
| int | _capacity |
| int | _limit |
| int | _mark |
| bool | _markSet |
Constructor & Destructor Documentation
◆ FloatArrayBuffer() [1/4]
| decaf::internal::nio::FloatArrayBuffer::FloatArrayBuffer | ( | int | size, |
| bool | readOnly = false ) |
Creates a FloatArrayBuffer object that has its backing array allocated internally and is then owned and deleted when this object is deleted.
The array is initially created with all elements initialized to zero.
- Parameters
-
size The size of the array, this is the limit we read and write to. readOnly Boolean indicating if this buffer should be read-only, default as false.
- Exceptions
-
IllegalArguementException if the capacity value is negative.
Referenced by FloatArrayBuffer().
◆ FloatArrayBuffer() [2/4]
| decaf::internal::nio::FloatArrayBuffer::FloatArrayBuffer | ( | float * | array, |
| int | size, | ||
| int | offset, | ||
| int | length, | ||
| bool | readOnly = false ) |
Creates a FloatArrayBuffer object that wraps the given array.
If the own flag is set then it will delete this array when this object is deleted.
- Parameters
-
array The actual array to wrap. size The size of the given array. offset The position that is this buffers start position. length The limit of how many bytes into the array this Buffer can write. readOnly Boolean indicating if this buffer should be read-only, default as false.
- Exceptions
-
NullPointerException if buffer is NULL IndexOutOfBoundsException if offset is greater than array capacity.
References array().
◆ FloatArrayBuffer() [3/4]
| decaf::internal::nio::FloatArrayBuffer::FloatArrayBuffer | ( | const decaf::lang::Pointer< ByteArrayAdapter > & | array, |
| int | offset, | ||
| int | capacity, | ||
| bool | readOnly = false ) |
Creates a byte buffer that wraps the passed ByteArrayAdapter and start at the given offset.
The capacity and limit of the new FloatArrayBuffer will be that of the remaining capacity of the passed buffer.
- Parameters
-
array The ByteArrayAdapter to wrap. offset The position that is this buffers start position. capacity The limit of how many bytes into the array this Buffer can write. readOnly Boolean indicating if this buffer should be read-only, default as false.
- Exceptions
-
NullPointerException if array is NULL IndexOutOfBoundsException if offset + length is greater than array size.
References array(), and decaf::nio::Buffer::capacity().
◆ FloatArrayBuffer() [4/4]
| decaf::internal::nio::FloatArrayBuffer::FloatArrayBuffer | ( | const FloatArrayBuffer & | other | ) |
Create a FloatArrayBuffer that mirrors this one, meaning it shares a reference to this buffers ByteArrayAdapter and when changes are made to that data it is reflected in both.
- Parameters
-
other The FloatArrayBuffer this one is to mirror.
References FloatArrayBuffer().
◆ ~FloatArrayBuffer()
|
virtual |
Member Function Documentation
◆ array()
|
virtual |
Returns the float array that backs this buffer (optional operation).Modifications to this buffer's content will cause the returned array's content to be modified, and vice versa.Invoke the hasArray method before invoking this method in order to ensure that this buffer has an accessible backing array.
- Returns
- the array that backs this Buffer.
- Exceptions
-
ReadOnlyBufferException if this Buffer is read only. UnsupportedOperationException if the underlying store has no array.
Implements decaf::nio::FloatBuffer.
Referenced by FloatArrayBuffer(), and FloatArrayBuffer().
◆ arrayOffset()
|
virtual |
Returns the offset within this buffer's backing array of the first element of the buffer (optional operation).Invoke the hasArray method before invoking this method in order to ensure that this buffer has an accessible backing array.
- Returns
- The offset into the backing array where index zero starts.
- Exceptions
-
ReadOnlyBufferException if this Buffer is read only. UnsupportedOperationException if the underlying store has no array.
Implements decaf::nio::FloatBuffer.
◆ asReadOnlyBuffer()
|
virtual |
Creates a new, read-only float buffer that shares this buffer's content.The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer; the new buffer itself, however, will be read-only and will not allow the shared content to be modified. The two buffers' position, limit, and mark values will be independent.If this buffer is itself read-only then this method behaves in exactly the same way as the duplicate method.The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer.
- Returns
- The new, read-only float buffer which the caller then owns.
Implements decaf::nio::FloatBuffer.
References decaf::nio::FloatBuffer::FloatBuffer().
◆ compact()
|
virtual |
Compacts this buffer.The bytes between the buffer's current position and its limit, if any, are copied to the beginning of the buffer. That is, the byte at index p = position() is copied to index zero, the byte at index p + 1 is copied to index one, and so forth until the byte at index limit() - 1 is copied to index n = limit() - 1 - p. The buffer's position is then set to n+1 and its limit is set to its capacity. The mark, if defined, is discarded.The buffer's position is set to the number of bytes copied, rather than to zero, so that an invocation of this method can be followed immediately by an invocation of another relative put method.
- Returns
- a reference to this FloatBuffer.
- Exceptions
-
ReadOnlyBufferException if this buffer is read-only
Implements decaf::nio::FloatBuffer.
References decaf::nio::FloatBuffer::FloatBuffer().
◆ duplicate()
|
virtual |
Creates a new float buffer that shares this buffer's content.The content of the new buffer will be that of this buffer. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.The new buffer's capacity, limit, position, and mark values will be identical to those of this buffer. The new buffer will be read-only if, and only if, this buffer is read-only.
- Returns
- a new float Buffer which the caller owns.
Implements decaf::nio::FloatBuffer.
References decaf::nio::FloatBuffer::FloatBuffer().
◆ get() [1/2]
|
virtual |
Relative get method.Reads the value at this buffer's current position, and then increments the position.
- Returns
- the float at the current position.
- Exceptions
-
BufferUnderflowException if there no more data to return.
Implements decaf::nio::FloatBuffer.
◆ get() [2/2]
|
virtual |
Absolute get method.Reads the value at the given index.
- Parameters
-
index The index in the Buffer where the float is to be read
- Returns
- the float that is located at the given index
- Exceptions
-
IndexOutOfBoundsException if index is not smaller than the buffer's limit
Implements decaf::nio::FloatBuffer.
◆ hasArray()
|
inlinevirtual |
Tells whether or not this buffer is backed by an accessible float array.If this method returns true then the array and arrayOffset methods may safely be invoked. Subclasses should override this method if they do not have a backing array as this class always returns true.
- Returns
- true if, and only if, this buffer is backed by an array and is not read-only
Implements decaf::nio::FloatBuffer.
◆ isReadOnly()
|
inlinevirtual |
Tells whether or not this buffer is read-only.
- Returns
- true if, and only if, this buffer is read-only.
Implements decaf::nio::Buffer.
◆ put() [1/2]
|
virtual |
Writes the given floats into this buffer at the current position, and then increments the position.
- Parameters
-
value The floats value to be written.
- Returns
- a reference to this buffer.
- Exceptions
-
BufferOverflowException if this buffer's current position is not smaller than its limit ReadOnlyBufferException if this buffer is read-only
Implements decaf::nio::FloatBuffer.
References decaf::nio::FloatBuffer::FloatBuffer().
◆ put() [2/2]
|
virtual |
Writes the given floats into this buffer at the given index.
- Parameters
-
index The position in the Buffer to write the data. value The floats to write.
- Returns
- a reference to this buffer.
- Exceptions
-
IndexOutOfBoundsException if index greater than the buffer's limit minus the size of the type being written, or index is negative. ReadOnlyBufferException if this buffer is read-only.
Implements decaf::nio::FloatBuffer.
References decaf::nio::FloatBuffer::FloatBuffer().
◆ setReadOnly()
|
inlineprotectedvirtual |
Sets this FloatArrayBuffer as Read-Only.
- Parameters
-
value Boolean value, true if this buffer is to be read-only, false otherwise.
◆ slice()
|
virtual |
Creates a new FloatBuffer whose content is a shared subsequence of this buffer's content.The content of the new buffer will start at this buffer's current position. Changes to this buffer's content will be visible in the new buffer, and vice versa; the two buffers' position, limit, and mark values will be independent.The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer, and its mark will be undefined. The new buffer will be read-only if, and only if, this buffer is read-only.
- Returns
- the newly create FloatBuffer which the caller owns.
Implements decaf::nio::FloatBuffer.
References decaf::nio::FloatBuffer::FloatBuffer().
The documentation for this class was generated from the following file:
- src/main/decaf/internal/nio/FloatArrayBuffer.h
