Package org.flag4j.util

Enum Class Axis2D

java.lang.Object

java.lang.Enum<Axis2D>

org.flag4j.util.Axis2D

All Implemented Interfaces:

Serializable, Comparable<Axis2D>, Constable

public enum Axis2D
extends Enum<Axis2D>

Simple enum class for two-dimensional axis. The row axis has ordinal 0 and the column axis has ordinal 1.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COL	Column of 2D tensor
ROW	Row of 2D tensor.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Axis2D()

Method Summary

Modifier and Type	Method	Description
static int[]	allAxes()	Gets an array of all axes ordinals.
static int	col()	Get the ordinal of the column axis in 2D.
static int	row()	Get the ordinal of the row axis in 2D.
static Axis2D	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Axis2D[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ROW

public static final Axis2D ROW

Row of 2D tensor.

COL

public static final Axis2D COL

Column of 2D tensor

Constructor Details

Axis2D

private Axis2D()

Method Details

values

public static Axis2D[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Axis2D valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

row

public static int row()

Get the ordinal of the row axis in 2D.

Returns:

The ordinal of the row axis in 2D.

col

public static int col()

Get the ordinal of the column axis in 2D.

Returns:

The ordinal of the column axis in 2D.

allAxes

public static int[] allAxes()

Gets an array of all axes ordinals.

Returns:

An array of all axes ordinals.