net.viktorc.detroid.framework.engine

Enum Bitboard.Rank

Object

Enum<Bitboard.Rank>

Bitboard.Rank

All Implemented Interfaces:

Serializable, Comparable<Bitboard.Rank>

Enclosing class:

Bitboard

public static enum Bitboard.Rank
extends Enum<Bitboard.Rank>

An enum type for the 8 ranks/rows of a chess board. Each constant has a field that contains a long with only the byte on the rank's index set.

Author:

Viktor

Enum Constant Summary

Enum Constants

Enum Constant and Description
R1
R2
R3
R4
R5
R6
R7
R8

Field Summary

Fields

Modifier and Type	Field and Description
long	bitboard
byte	ind

Method Summary

Modifier and Type	Method and Description
static Bitboard.Rank	getBySquareIndex(int sqrInd) Returns the rank of the chess board on which the input parameter square lies.
static Bitboard.Rank	valueOf(String name) Returns the enum constant of this type with the specified name.
static Bitboard.Rank[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

R1

public static final Bitboard.Rank R1

R2

public static final Bitboard.Rank R2

R3

public static final Bitboard.Rank R3

R4

public static final Bitboard.Rank R4

R5

public static final Bitboard.Rank R5

R6

public static final Bitboard.Rank R6

R7

public static final Bitboard.Rank R7

R8

public static final Bitboard.Rank R8

Field Detail

ind

public final byte ind

bitboard

public final long bitboard

Method Detail

values

public static Bitboard.Rank[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Bitboard.Rank c : Bitboard.Rank.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Bitboard.Rank valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getBySquareIndex

public static Bitboard.Rank getBySquareIndex(int sqrInd)

Returns the rank of the chess board on which the input parameter square lies.

Parameters:

sqrInd - The index of the square.

Returns:

The rank on which the square the index points to is.