com.tagtraum.jipes.math

Class SparseBackingBuffer

java.lang.Object

com.tagtraum.jipes.math.SparseBackingBuffer

All Implemented Interfaces:

MatrixBackingBuffer, Cloneable

public class SparseBackingBuffer
extends Object
implements MatrixBackingBuffer, Cloneable

A sparse matrix backing buffer uses a HashMap as internal datastructure. Only values that differ from the defaultValue (can be set via SparseBackingBuffer(float)) are actually stored. If you intend to place values in most possible matrix positions, this is not a suitable implementation.

Author:

Hendrik Schreiber

Constructor Summary

Constructors

Constructor and Description
SparseBackingBuffer() Sparse backing buffer with default value 0f.
SparseBackingBuffer(float defaultValue) Creates a sparse backing buffer with the given default value.

Method Summary

Modifier and Type	Method and Description
void	allocate(int size) Allocates the internal data structure.
Object	clone()
float	get(int index) Reads a value.
boolean	isAllocated() Indicates whether the internal data structure is already allocated.
void	set(int index, float value) Write a value.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SparseBackingBuffer

public SparseBackingBuffer(float defaultValue)

Creates a sparse backing buffer with the given default value. That means, whenever no value can be found in the internal map, the default value is returned.

Parameters:

defaultValue - default value

SparseBackingBuffer

public SparseBackingBuffer()

Sparse backing buffer with default value 0f.

Method Detail

allocate

public void allocate(int size)

Description copied from interface: MatrixBackingBuffer

Allocates the internal data structure.

Specified by:

allocate in interface MatrixBackingBuffer

Parameters:

size - size

isAllocated

public boolean isAllocated()

Description copied from interface: MatrixBackingBuffer

Indicates whether the internal data structure is already allocated.

Specified by:

isAllocated in interface MatrixBackingBuffer

Returns:

true or false

set

public void set(int index,
                float value)

Description copied from interface: MatrixBackingBuffer

Write a value.

Specified by:

set in interface MatrixBackingBuffer

Parameters:

index - index

value - value

get

public float get(int index)

Description copied from interface: MatrixBackingBuffer

Reads a value.

Specified by:

get in interface MatrixBackingBuffer

Parameters:

index - index

Returns:

value

clone

public Object clone()
             throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException