NeuronSquareMesh2D.HorizontalDirection (Apache Commons Math 3.6.1 API)

org.apache.commons.math3.ml.neuralnet.twod

## Enum NeuronSquareMesh2D.HorizontalDirection

- java.lang.Object
- - java.lang.Enum<NeuronSquareMesh2D.HorizontalDirection>
  - - org.apache.commons.math3.ml.neuralnet.twod.NeuronSquareMesh2D.HorizontalDirection

- All Implemented Interfaces:
    Serializable, Comparable<NeuronSquareMesh2D.HorizontalDirection>
  Enclosing class:
    NeuronSquareMesh2D

      public static enum NeuronSquareMesh2D.HorizontalDirection
      extends Enum<NeuronSquareMesh2D.HorizontalDirection>

  Horizontal (along row) direction.
  Since:
    3.6

- - ### Enum Constant Summary

    Enum Constants
    Enum Constant and Description
    `CENTER` Current column.
    `LEFT` Column at the left of the current column.
    `RIGHT` Column at the right of the current column.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `static NeuronSquareMesh2D.HorizontalDirection` | `valueOf(String name)` Returns the enum constant of this type with the specified name.
    `static NeuronSquareMesh2D.HorizontalDirection[]` | `values()` Returns an array containing the constants of this enum type, in the order they are declared.

    - ### Methods inherited from class java.lang.Enum

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

    - ### Methods inherited from class java.lang.Object

      `getClass, notify, notifyAll, wait, wait, wait`

- - ### Enum Constant Detail

    - #### RIGHT

          public static final NeuronSquareMesh2D.HorizontalDirection RIGHT

      Column at the right of the current column.

    - #### CENTER

          public static final NeuronSquareMesh2D.HorizontalDirection CENTER

      Current column.

    - #### LEFT

          public static final NeuronSquareMesh2D.HorizontalDirection LEFT

      Column at the left of the current column.

  - ### Method Detail

    - #### values

          public static NeuronSquareMesh2D.HorizontalDirection[] 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 (NeuronSquareMesh2D.HorizontalDirection c : NeuronSquareMesh2D.HorizontalDirection.values())
              System.out.println(c);

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

    - #### valueOf

          public static NeuronSquareMesh2D.HorizontalDirection 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

Copyright © 2003–2016 The Apache Software Foundation. All rights reserved.