com.oracle.truffle.api.nodes

Enum NodeCost

java.lang.Object

java.lang.Enum<NodeCost>

com.oracle.truffle.api.nodes.NodeCost

All Implemented Interfaces:

Serializable, Comparable<NodeCost>, java.lang.constant.Constable

public enum NodeCost
extends Enum<NodeCost>

Represents a rough estimate for the cost of a Node. This estimate can be used by runtime systems or guest languages to implement heuristics based on Truffle ASTs.

Since:

0.8 or earlier

See Also:

Node.getCost()

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 and Description
MEGAMORPHIC This node represents a megamorphic version of an operation.
MONOMORPHIC This node represents a specialized monomorphic version of an operation.
NONE This node has literally no costs and should be ignored for heuristics.
POLYMORPHIC This node represents a polymorphic version of an operation.
UNINITIALIZED This node has a CompilerDirectives.transferToInterpreter() or CompilerDirectives.transferToInterpreterAndInvalidate() as its first unconditional statement.

Method Summary

Modifier and Type	Method and Description
static NodeCost	fromCount(int nodeCount) Finds the node cost for an associated node count.
boolean	isTrivial()
static NodeCost	valueOf(String name) Returns the enum constant of this type with the specified name.
static NodeCost[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final NodeCost NONE

This node has literally no costs and should be ignored for heuristics. This is particularly useful for wrapper and profiling nodes which should not influence the heuristics.

Since:

0.8 or earlier

UNINITIALIZED

public static final NodeCost UNINITIALIZED

This node has a CompilerDirectives.transferToInterpreter() or CompilerDirectives.transferToInterpreterAndInvalidate() as its first unconditional statement.

Since:

0.8 or earlier

MONOMORPHIC

public static final NodeCost MONOMORPHIC

This node represents a specialized monomorphic version of an operation.

Since:

0.8 or earlier

POLYMORPHIC

public static final NodeCost POLYMORPHIC

This node represents a polymorphic version of an operation. For multiple chained polymorphic nodes the first may return NodeCost.MONOMORPHIC and all additional nodes should return NodeCost.POLYMORPHIC.

Since:

0.8 or earlier

MEGAMORPHIC

public static final NodeCost MEGAMORPHIC

This node represents a megamorphic version of an operation. This value should only be used if the operation implementation supports monomorphism and polymorphism otherwise NodeCost.MONOMORPHIC should be used instead.

Since:

0.8 or earlier

Method Detail

values

public static NodeCost[] values()

Returns:

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

valueOf

public static NodeCost valueOf(String name)

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

isTrivial

public boolean isTrivial()

Since:

0.8 or earlier

fromCount

public static NodeCost fromCount(int nodeCount)

Finds the node cost for an associated node count. Returns NodeCost.UNINITIALIZED for 0, NodeCost.MONOMORPHIC for 1 and NodeCost.POLYMORPHIC for any other value.

Since:

19.0