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

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

Inheritance diagram for decaf::nio::DoubleBuffer:

Public Member Functions
virtual	~DoubleBuffer ()
virtual std::string	toString () const
virtual double *	array ()=0
	Returns the double 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 DoubleBuffer *	asReadOnlyBuffer () const =0
	Creates a new, read-only double buffer that shares this buffer's content.
virtual DoubleBuffer &	compact ()=0
	Compacts this buffer.
virtual DoubleBuffer *	duplicate ()=0
	Creates a new double buffer that shares this buffer's content.
virtual double	get ()=0
	Relative get method.
virtual double	get (int index) const =0
	Absolute get method.
DoubleBuffer &	get (std::vector< double > buffer)
	Relative bulk get method.
DoubleBuffer &	get (double *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 double array.
DoubleBuffer &	put (DoubleBuffer &src)
	This method transfers the doubles remaining in the given source buffer into this buffer.
DoubleBuffer &	put (const double *buffer, int size, int offset, int length)
	This method transfers doubles into this buffer from the given source array.
DoubleBuffer &	put (std::vector< double > &buffer)
	This method transfers the entire content of the given source doubles array into this buffer.
virtual DoubleBuffer &	put (double value)=0
	Writes the given doubles into this buffer at the current position, and then increments the position.
virtual DoubleBuffer &	put (int index, double value)=0
	Writes the given doubles into this buffer at the given index.
virtual DoubleBuffer *	slice () const =0
	Creates a new DoubleBuffer whose content is a shared subsequence of this buffer's content.
virtual int	compareTo (const DoubleBuffer &value) const

virtual bool	equals (const DoubleBuffer &value) const

virtual bool	operator== (const DoubleBuffer &value) const

virtual bool	operator< (const DoubleBuffer &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.
virtual bool	isReadOnly () const =0
	Tells whether or not this buffer is read-only.
Public Member Functions inherited from decaf::lang::Comparable< DoubleBuffer >
virtual	~Comparable ()
virtual int	compareTo (const DoubleBuffer &value) const =0
	Compares this object with the specified object for order.
virtual bool	equals (const DoubleBuffer &value) const =0
virtual bool	operator== (const DoubleBuffer &value) const =0
	Compares equality between this object and the one passed.
virtual bool	operator< (const DoubleBuffer &value) const =0
	Compares this object to another and returns true if this object is considered to be less than the one passed.

Static Public Member Functions
static DoubleBuffer *	allocate (int capacity)
	Allocates a new DoubleBuffer.
static DoubleBuffer *	wrap (double *array, int size, int offset, int length)
	Wraps the passed buffer with a new DoubleBuffer.
static DoubleBuffer *	wrap (std::vector< double > &buffer)
	Wraps the passed STL double Vector in a DoubleBuffer.

Protected Member Functions
	DoubleBuffer (int capacity)
	Creates a DoubleBuffer object that has its backing array allocated internally and is then owned and deleted when this object is deleted.

Additional Inherited Members
Protected Attributes inherited from decaf::nio::Buffer
int	_position
int	_capacity
int	_limit
int	_mark
bool	_markSet

Detailed Description

This class defines four categories of operations upon double buffers:

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

Double buffers can be created either by allocation, which allocates space for the buffer's content, by wrapping an existing double 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.

Since: 1.0

Constructor & Destructor Documentation

decaf::nio::DoubleBuffer::DoubleBuffer ( int capacity )

protected

Creates a DoubleBuffer 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 doubles

Exceptions

IllegalArguementException if capacity is negative.

virtual decaf::nio::DoubleBuffer::~DoubleBuffer ( )

inlinevirtual

Member Function Documentation

static DoubleBuffer* decaf::nio::DoubleBuffer::allocate ( int capacity )

static

Allocates a new DoubleBuffer.

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 doubles.

Returns: the DoubleBuffer that was allocated, caller owns.

Exceptions

IllegalArgumentException is the capacity value is negative.

virtual double* decaf::nio::DoubleBuffer::array ( )

pure virtual

Returns the double 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::DoubleArrayBuffer.

virtual int decaf::nio::DoubleBuffer::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::DoubleArrayBuffer.

virtual DoubleBuffer* decaf::nio::DoubleBuffer::asReadOnlyBuffer ( ) const

pure virtual

Creates a new, read-only double 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 double buffer which the caller then owns.

Implemented in decaf::internal::nio::DoubleArrayBuffer.

virtual DoubleBuffer& decaf::nio::DoubleBuffer::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 DoubleBuffer.

Exceptions

ReadOnlyBufferException if this buffer is read-only.

Implemented in decaf::internal::nio::DoubleArrayBuffer.

virtual int decaf::nio::DoubleBuffer::compareTo ( const DoubleBuffer & value ) const

virtual

virtual DoubleBuffer* decaf::nio::DoubleBuffer::duplicate ( )

pure virtual

Creates a new double 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 double Buffer which the caller owns.

Implemented in decaf::internal::nio::DoubleArrayBuffer.

virtual bool decaf::nio::DoubleBuffer::equals ( const DoubleBuffer & value ) const

virtual

virtual double decaf::nio::DoubleBuffer::get ( )

pure virtual

Relative get method.

Reads the value at this buffer's current position, and then increments the position.

Returns: the double at the current position.

Exceptions

BufferUnderflowException if there no more data to return.

Implemented in decaf::internal::nio::DoubleArrayBuffer.

virtual double decaf::nio::DoubleBuffer::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 double is to be read.

Returns: the double that is located at the given index.

Exceptions

IndexOutOfBoundsException if index is not smaller than the buffer's limit

Implemented in decaf::internal::nio::DoubleArrayBuffer.

DoubleBuffer& decaf::nio::DoubleBuffer::get ( std::vector< double > 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 iIf there are fewer than length doubles remaining in this buffer

DoubleBuffer& decaf::nio::DoubleBuffer::get	(	double *	buffer,
		int	size,
		int	offset,
		int	length
	)

Relative bulk get method.

This method transfers doubles from this buffer into the given destination array. If there are fewer doubles 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 doubles 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 buffer passed.
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 doubles remaining in this buffer
NullPointerException	if the passed buffer is null.
IndexOutOfBoundsException	if the preconditions of size, offset, or length are not met.

virtual bool decaf::nio::DoubleBuffer::hasArray ( ) const

pure virtual

Tells whether or not this buffer is backed by an accessible double 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::DoubleArrayBuffer.

virtual bool decaf::nio::DoubleBuffer::operator< ( const DoubleBuffer & value ) const

virtual

virtual bool decaf::nio::DoubleBuffer::operator== ( const DoubleBuffer & value ) const

virtual

DoubleBuffer& decaf::nio::DoubleBuffer::put ( DoubleBuffer & src )

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

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

Otherwise, this method copies n = src.remaining() doubles 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 doubles 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 doubles in the source buffer
IllegalArgumentException	if the source buffer is this buffer.
ReadOnlyBufferException	if this buffer is read-only.

DoubleBuffer& decaf::nio::DoubleBuffer::put	(	const double *	buffer,
		int	size,
		int	offset,
		int	length
	)

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

If there are more doubles to be copied from the array than remain in this buffer, that is, if length > remaining(), then no doubles 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 doubles are to be read.
size	The size of the buffer passed.
offset	The offset within the array of the first char to be read.
length	The number of doubles 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.

DoubleBuffer& decaf::nio::DoubleBuffer::put ( std::vector< double > & buffer )

This method transfers the entire content of the given source doubles 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 DoubleBuffer.

Returns: a reference to this buffer.

Exceptions

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

virtual DoubleBuffer& decaf::nio::DoubleBuffer::put ( double value )

pure virtual

Writes the given doubles into this buffer at the current position, and then increments the position.

Parameters

value The doubles 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::DoubleArrayBuffer.

virtual DoubleBuffer& decaf::nio::DoubleBuffer::put	(	int	index,
		double	value
	)

pure virtual

Writes the given doubles into this buffer at the given index.

Parameters

index	The position in the Buffer to write the data.
value	The doubles 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 the index is negative.
ReadOnlyBufferException	if this buffer is read-only.

Implemented in decaf::internal::nio::DoubleArrayBuffer.

virtual DoubleBuffer* decaf::nio::DoubleBuffer::slice ( ) const

pure virtual

Creates a new DoubleBuffer 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 DoubleBuffer which the caller owns.

Implemented in decaf::internal::nio::DoubleArrayBuffer.

virtual std::string decaf::nio::DoubleBuffer::toString ( ) const

virtual

Returns: a std::string describing this object

static DoubleBuffer* decaf::nio::DoubleBuffer::wrap	(	double *	array,
		int	size,
		int	offset,
		int	length
	)

static

Wraps the passed buffer with a new DoubleBuffer.

The new buffer will be backed by the given double 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 passed in array.
offset	The offset of the subarray to be used.
length	The length of the subarray to be used.

Returns: a new DoubleBuffer 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 DoubleBuffer* decaf::nio::DoubleBuffer::wrap ( std::vector< double > & buffer )

static

Wraps the passed STL double Vector in a DoubleBuffer.

The new buffer will be backed by the given double 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 DoubleBuffer that is backed by buffer, caller owns.

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

src/main/decaf/nio/DoubleBuffer.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation