org.dhatim.fastexcel

Class BitMatrix

java.lang.Object

org.dhatim.fastexcel.BitMatrix

All Implemented Interfaces:

Cloneable

public final class BitMatrix
extends Object
implements Cloneable

Represents a 2D matrix of bits. In function arguments below, and throughout the common module, x is the column position, and y is the row position. The ordering is always x, y. The origin is at the top-left.

Internally the bits are represented in a 1-D array of 32-bit ints. However, each row begins with a new int. This is done intentionally so that we can copy out a row into a BitArray very efficiently.

The ordering of bits is row-major. Within each int, the least significant bits are used first, meaning they represent lower x values. This is compatible with BitArray's implementation.

Author:

Sean Owen, [email protected] (Daniel Switkin)

Constructor Summary

Constructors

Constructor and Description
BitMatrix(int dimension) Creates an empty square BitMatrix.
BitMatrix(int width, int height) Creates an empty BitMatrix.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all bits (sets to false).
BitMatrix	clone()
boolean	equals(Object o)
void	flip() Flips every bit in the matrix.
void	flip(int x, int y) Flips the given bit.
boolean	get(int x, int y) Gets the requested bit, where true means black.
int	getHeight()
int	getRowSize()
int	getWidth()
int	hashCode()
void	set(int x, int y) Sets the given bit to true.
void	setRegion(int left, int top, int width, int height) Sets a square region of the bit matrix to true.
String	toString()
String	toString(String setString, String unsetString)
String	toString(String setString, String unsetString, String lineSeparator) Deprecated. call toString(String,String) only, which uses \n line separator always
void	unset(int x, int y)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

BitMatrix

public BitMatrix(int dimension)

Creates an empty square BitMatrix.

Parameters:

dimension - height and width

BitMatrix

public BitMatrix(int width,
                 int height)

Creates an empty BitMatrix.

Parameters:

width - bit matrix width

height - bit matrix height

Method Detail

get

public boolean get(int x,
                   int y)

Gets the requested bit, where true means black.

Parameters:

x - The horizontal component (i.e. which column)

y - The vertical component (i.e. which row)

Returns:

value of given bit in matrix

set

public void set(int x,
                int y)

Sets the given bit to true.

Parameters:

x - The horizontal component (i.e. which column)

y - The vertical component (i.e. which row)

unset

public void unset(int x,
                  int y)

flip

public void flip(int x,
                 int y)

Flips the given bit.

Parameters:

x - The horizontal component (i.e. which column)

y - The vertical component (i.e. which row)

flip

public void flip()

Flips every bit in the matrix.

clear

public void clear()

Clears all bits (sets to false).

setRegion

public void setRegion(int left,
                      int top,
                      int width,
                      int height)

Sets a square region of the bit matrix to true.

Parameters:

left - The horizontal position to begin at (inclusive)

top - The vertical position to begin at (inclusive)

width - The width of the region

height - The height of the region

getWidth

public int getWidth()

Returns:

The width of the matrix

getHeight

public int getHeight()

Returns:

The height of the matrix

getRowSize

public int getRowSize()

Returns:

The row size of the matrix

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

Returns:

string representation using "X" for set and " " for unset bits

toString

public String toString(String setString,
                       String unsetString)

Parameters:

setString - representation of a set bit

unsetString - representation of an unset bit

Returns:

string representation of entire matrix utilizing given strings

toString

@Deprecated
public String toString(String setString,
                                   String unsetString,
                                   String lineSeparator)

Deprecated. call toString(String,String) only, which uses \n line separator always

Parameters:

setString - representation of a set bit

unsetString - representation of an unset bit

lineSeparator - newline character in string representation

Returns:

string representation of entire matrix utilizing given strings and line separator

clone

public BitMatrix clone()

Overrides:

clone in class Object