Module org.refcodes.audio

Package org.refcodes.audio

Enum Class CurveFunctionFunction

java.lang.Object

java.lang.Enum<CurveFunctionFunction>

org.refcodes.audio.CurveFunctionFunction

All Implemented Interfaces:

Serializable, Comparable<CurveFunctionFunction>, Constable

public enum CurveFunctionFunction
extends Enum<CurveFunctionFunction>

Enumeration containing some predefined trigonometric functions.

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
COSINE
SAWTOOTH
SINE
SQUARE
TANGENT
TRIANGLE

Method Summary

Modifier and Type	Method	Description
Function<Double,Double>	getFunction()	Returns the according trigonometric function.
static CurveFunctionFunction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CurveFunctionFunction[]	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

SINE

public static final CurveFunctionFunction SINE

COSINE

public static final CurveFunctionFunction COSINE

TANGENT

public static final CurveFunctionFunction TANGENT

SAWTOOTH

public static final CurveFunctionFunction SAWTOOTH

SQUARE

public static final CurveFunctionFunction SQUARE

TRIANGLE

public static final CurveFunctionFunction TRIANGLE

Method Details

values

public static CurveFunctionFunction[] 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 CurveFunctionFunction 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

getFunction

public Function<Double,Double> getFunction()

Returns the according trigonometric function.

Returns:

Thhe according according trigonometric function.