org.elasticsearch.common.math

Enum MathUtils

java.lang.Object

java.lang.Enum<MathUtils>

org.elasticsearch.common.math.MathUtils

All Implemented Interfaces:

Serializable, Comparable<MathUtils>

public enum MathUtils
extends Enum<MathUtils>

Method Summary

Methods

Modifier and Type	Method and Description
static int	mod(int v, int m) Return the (positive) remainder of the division of v by mod.
static MathUtils	valueOf(String name) Returns the enum constant of this type with the specified name.
static MathUtils[]	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

Method Detail

values

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

Returns:

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

valueOf

public static MathUtils 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

mod

public static int mod(int v,
      int m)

Return the (positive) remainder of the division of v by mod.