CyclicalTracker.CyclicalMode (Deep Java Library 0.24.0 API specification)

java.lang.Object
- java.lang.Enum<CyclicalTracker.CyclicalMode>
- - ai.djl.training.tracker.CyclicalTracker.CyclicalMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CyclicalTracker.CyclicalMode>

Enclosing class:

CyclicalTracker
```
public static enum CyclicalTracker.CyclicalMode
extends java.lang.Enum<CyclicalTracker.CyclicalMode>
```
CyclicalTracker provides three predefined cyclical modes and can be selected by this enum.
- TRIANGULAR: A basic triangular cycle without amplitude scaling.
- TRIANGULAR2: A basic triangular cycle that scales initial amplitude by half each cycle.
- EXP_RANGE: A cycle that scales initial amplitude by (gamma^{cycleIterations}) at each cycle iteration.

Enum Constant Summary

Enum Constants
Enum Constant Description

EXP_RANGE

TRIANGULAR

TRIANGULAR2

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static CyclicalTracker.CyclicalMode`	`valueOf(java.lang.String name)`	Returns the enum constant of this type with the specified name.
`static CyclicalTracker.CyclicalMode[]`	`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
  - TRIANGULAR
```
public static final CyclicalTracker.CyclicalMode TRIANGULAR
```
  - TRIANGULAR2
```
public static final CyclicalTracker.CyclicalMode TRIANGULAR2
```
  - EXP_RANGE
```
public static final CyclicalTracker.CyclicalMode EXP_RANGE
```
- Method Detail
  - values
```
public static CyclicalTracker.CyclicalMode[] 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 (CyclicalTracker.CyclicalMode c : CyclicalTracker.CyclicalMode.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CyclicalTracker.CyclicalMode valueOf(java.lang.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:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null