decaf::nio::FloatBuffer Class Reference

This class defines four categories of operations upon float buffers: More...

#include <src/main/decaf/nio/FloatBuffer.h>

Inheritance diagram for decaf::nio::FloatBuffer:

Public Member Functions
virtual	~FloatBuffer ()
virtual std::string	toString () const
virtual float *	array ()=0
	Returns the float array that backs this buffer (optional operation).
virtual int	arrayOffset ()=0
	Returns the offset within this buffer's backing array of the first element of the buffer (optional operation).
virtual FloatBuffer *	asReadOnlyBuffer () const =0
	Creates a new, read-only float buffer that shares this buffer's content.
virtual FloatBuffer &	compact ()=0
	Compacts this buffer.
virtual FloatBuffer *	duplicate ()=0
	Creates a new float buffer that shares this buffer's content.
virtual float	get ()=0
	Relative get method.
virtual float	get (int index) const =0
	Absolute get method.
FloatBuffer &	get (std::vector< float > buffer)
	Relative bulk get method.
FloatBuffer &	get (float *buffer, int size, int offset, int length)
	Relative bulk get method.
virtual bool	hasArray () const =0
	Tells whether or not this buffer is backed by an accessible float array.
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 FloatBuffer &	put (float value)=0
	Writes the given floats into this buffer at the current position, and then increments the position.
virtual FloatBuffer &	put (int index, float value)=0
	Writes the given floats into this buffer at the given index.
virtual FloatBuffer *	slice () const =0
	Creates a new FloatBuffer whose content is a shared subsequence of this buffer's content.
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
Static Public Member Functions
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 Member Functions
	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.

---

Detailed Description

This class defines four categories of operations upon float buffers:

o Absolute and relative get and put methods that read and write single floats; o Relative bulk get methods that transfer contiguous sequences of floats from this buffer into an array; and o Relative bulk put methods that transfer contiguous sequences of floats from a float array or some other float buffer into this buffer o Methods for compacting, duplicating, and slicing a float buffer.

Double buffers can be created either by allocation, which allocates space for the buffer's content, by wrapping an existing float array into a buffer, or by creating a view of an existing byte buffer

Methods in this class that do not otherwise have a value to return are specified to return the buffer upon which they are invoked. This allows method invocations to be chained.

---

Constructor & Destructor Documentation

decaf::nio::FloatBuffer::FloatBuffer

(

int

capacity

)

[protected]

Creates a FloatBuffer 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:

capacity

The size and limit of the Buffer in floats.

Exceptions:

IllegalArguementException

if capacity is negative.

virtual decaf::nio::FloatBuffer::~FloatBuffer

(

)

[inline, virtual]

---

Member Function Documentation

static FloatBuffer* decaf::nio::FloatBuffer::allocate

(

int

capacity

)

[static]

Allocates a new Double buffer.

The new buffer's position will be zero, its limit will be its capacity, and its mark will be undefined. It will have a backing array, and its array offset will be zero.

Parameters:

capacity

The size of the Double buffer in floats.

Returns:

the FloatBuffer that was allocated, caller owns.

virtual float* decaf::nio::FloatBuffer::array

(

)

[pure 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.

Implemented in decaf::internal::nio::FloatArrayBuffer.

virtual int decaf::nio::FloatBuffer::arrayOffset

(

)

[pure 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.

Implemented in decaf::internal::nio::FloatArrayBuffer.

virtual FloatBuffer* decaf::nio::FloatBuffer::asReadOnlyBuffer

(

)

const [pure 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.

Implemented in decaf::internal::nio::FloatArrayBuffer.

virtual FloatBuffer& decaf::nio::FloatBuffer::compact

(

)

[pure 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

Implemented in decaf::internal::nio::FloatArrayBuffer.

virtual int decaf::nio::FloatBuffer::compareTo

(

const FloatBuffer &

value

)

const [virtual]

virtual FloatBuffer* decaf::nio::FloatBuffer::duplicate

(

)

[pure 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.

Implemented in decaf::internal::nio::FloatArrayBuffer.

virtual bool decaf::nio::FloatBuffer::equals

(

const FloatBuffer &

value

)

const [virtual]

FloatBuffer& decaf::nio::FloatBuffer::get

(

std::vector< float >

buffer

)

Relative bulk get method.

This method transfers values from this buffer into the given destination vector. An invocation of this method of the form src.get(a) behaves in exactly the same way as the invocation. The vector must be sized to the amount of data that is to be read, that is to say, the caller should call buffer.resize( N ) before calling this get method.

Returns:

a reference to this Buffer.

Exceptions:

BufferUnderflowException

if there are fewer than length floats remaining in this buffer

virtual float decaf::nio::FloatBuffer::get

(

int

index

)

const [pure 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

Implemented in decaf::internal::nio::FloatArrayBuffer.

FloatBuffer& decaf::nio::FloatBuffer::get	(	float *	buffer,
		int	size,
		int	offset,
		int	length
	)

Relative bulk get method.

This method transfers floats from this buffer into the given destination array. If there are fewer floats remaining in the buffer than are required to satisfy the request, that is, if length > remaining(), then no bytes are transferred and a BufferUnderflowException is thrown.

Otherwise, this method copies length floats from this buffer into the given array, starting at the current position of this buffer and at the given offset in the array. The position of this buffer is then incremented by length.

Parameters:

buffer	The pointer to an allocated buffer to fill.
size	The size of the passed in buffer.
offset	The position in the buffer to start filling.
length	The amount of data to put in the passed buffer.

Returns:

a reference to this Buffer.

Exceptions:

BufferUnderflowException	if there are fewer than length floats remaining in this buffer
NullPointerException	if the passed buffer is null.
IndexOutOfBoundsException	if the preconditions of size, offset, or length are not met.

virtual float decaf::nio::FloatBuffer::get

(

)

[pure 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.

Implemented in decaf::internal::nio::FloatArrayBuffer.

virtual bool decaf::nio::FloatBuffer::hasArray

(

)

const [pure virtual]

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

Implemented in decaf::internal::nio::FloatArrayBuffer.

virtual bool decaf::nio::FloatBuffer::operator<

(

const FloatBuffer &

value

)

const [virtual]

virtual bool decaf::nio::FloatBuffer::operator==

(

const FloatBuffer &

value

)

const [virtual]

virtual FloatBuffer& decaf::nio::FloatBuffer::put

(

float

value

)

[pure 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

Implemented in decaf::internal::nio::FloatArrayBuffer.

virtual FloatBuffer& decaf::nio::FloatBuffer::put	(	int	index,
		float	value
	)		[pure 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.

Implemented in decaf::internal::nio::FloatArrayBuffer.

FloatBuffer& decaf::nio::FloatBuffer::put	(	const float *	buffer,
		int	size,
		int	offset,
		int	length
	)

This method transfers floats into this buffer from the given source array.

If there are more floats to be copied from the array than remain in this buffer, that is, if length > remaining(), then no floats are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies length bytes from the given array into this buffer, starting at the given offset in the array and at the current position of this buffer. The position of this buffer is then incremented by length.

Parameters:

buffer	The array from which floats are to be read.
size	The size of the passed in buffer.
offset	The offset within the array of the first float to be read.
length	The number of floats to be read from the given array.

Returns:

a reference to this buffer.

Exceptions:

BufferOverflowException	if there is insufficient space in this buffer
ReadOnlyBufferException	if this buffer is read-only
NullPointerException	if the passed buffer is null.
IndexOutOfBoundsException	if the preconditions of size, offset, or length are not met.

FloatBuffer& decaf::nio::FloatBuffer::put

(

std::vector< float > &

buffer

)

This method transfers the entire content of the given source floats array into this buffer.

This is the same as calling put( &buffer[0], 0, buffer.size().

Parameters:

buffer

The buffer whose contents are copied to this FloatBuffer

Returns:

a reference to this buffer.

Exceptions:

BufferOverflowException	if there is insufficient space in this buffer
ReadOnlyBufferException	if this buffer is read-only

FloatBuffer& decaf::nio::FloatBuffer::put

(

FloatBuffer &

src

)

This method transfers the floats remaining in the given source buffer into this buffer.

If there are more floats remaining in the source buffer than in this buffer, that is, if src.remaining() > remaining(), then no floats are transferred and a BufferOverflowException is thrown.

Otherwise, this method copies n = src.remaining() floats from the given buffer into this buffer, starting at each buffer's current position. The positions of both buffers are then incremented by n.

Parameters:

src	The buffer to take floats from an place in this one.

Returns:

a reference to this buffer.

Exceptions:

BufferOverflowException	if there is insufficient space in this buffer for the remaining floats in the source buffer
IllegalArgumentException	if the source buffer is this buffer.
ReadOnlyBufferException	if this buffer is read-only.

virtual FloatBuffer* decaf::nio::FloatBuffer::slice

(

)

const [pure 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.

Implemented in decaf::internal::nio::FloatArrayBuffer.

virtual std::string decaf::nio::FloatBuffer::toString

(

)

const [virtual]

Returns:

a std::string describing this object

static FloatBuffer* decaf::nio::FloatBuffer::wrap	(	float *	array,
		int	size,
		int	offset,
		int	length
	)		[static]

Wraps the passed buffer with a new FloatBuffer.

The new buffer will be backed by the given float array; that is, modifications to the buffer will cause the array to be modified and vice versa. The new buffer's capacity will be array.length, its position will be offset, its limit will be offset + length, and its mark will be undefined. Its backing array will be the given array, and its array offset will be zero.

Parameters:

array	The array that will back the new buffer.
size	The size of the array that was passed in.
offset	The offset of the subarray to be used.
length	The length of the subarray to be used.

Returns:

a new FloatBuffer that is backed by buffer, caller owns.

Exceptions:

NullPointerException	if the array pointer is NULL.
IndexOutOfBoundsException	if the preconditions of size, offset, or length are not met.

static FloatBuffer* decaf::nio::FloatBuffer::wrap

(

std::vector< float > &

buffer

)

[static]

Wraps the passed STL float Vector in a FloatBuffer.

The new buffer will be backed by the given float array; modifications to the buffer will cause the array to be modified and vice versa. The new buffer's capacity and limit will be buffer.size(), its position will be zero, and its mark will be undefined. Its backing array will be the given array, and its array offset will be zero.

Parameters:

buffer

- The vector that will back the new buffer, the vector must have been sized to the desired size already by calling vector.resize( N ).

Returns:

a new FloatBuffer that is backed by buffer, caller owns.

---

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

• src/main/decaf/nio/FloatBuffer.h