org.graalvm.compiler.nodes

Class ProfileData.BranchProbabilityData

java.lang.Object

org.graalvm.compiler.nodes.ProfileData

org.graalvm.compiler.nodes.ProfileData.BranchProbabilityData

Enclosing class:

ProfileData

public static final class ProfileData.BranchProbabilityData
extends ProfileData

Profile data for one successor of a node. Also used for two-way branches like IfNode or WithExceptionNode. When used for a branch, the probability stored within is the probability of a "designated" successor (e.g., the true or non-exceptional successor), the other successor's probability can be computed from it. As instances of this class are immutable, any of the smart constructors may return shared instances.

Nested Class Summary

Nested classes/interfaces inherited from class org.graalvm.compiler.nodes.ProfileData

ProfileData.BranchProbabilityData, ProfileData.LoopFrequencyData, ProfileData.ProfileSource, ProfileData.SwitchProbabilityData

Field Summary

Fields inherited from class org.graalvm.compiler.nodes.ProfileData

profileSource

Method Summary

Modifier and Type	Method and Description
ProfileData.BranchProbabilityData	combineAndWithNegated(ProfileData.BranchProbabilityData other) Computes combined profile data for not short-circuiting evaluation of this && !other.
static ProfileData.BranchProbabilityData	combineShortCircuitOr(ProfileData.BranchProbabilityData a, ProfileData.BranchProbabilityData b) Computes combined profile data for short-circuiting evaluation of a || b.
ProfileData.BranchProbabilityData	copy(double newProbability)
static ProfileData.BranchProbabilityData	create(double designatedSuccessorProbability, ProfileData.ProfileSource profileSource) Returns a profile data object with the given designated successor probability and profile source.
double	getDesignatedSuccessorProbability()
double	getNegatedProbability()
static ProfileData.BranchProbabilityData	injected(double probability)
static ProfileData.BranchProbabilityData	injected(double probability, boolean negated)
ProfileData.BranchProbabilityData	negated()
static ProfileData.BranchProbabilityData	profiled(double probability)
String	toString()
static ProfileData.BranchProbabilityData	unknown() Returns a singleton branch profile object with an unknown source and designated successor probability 0.5.
static ProfileData.BranchProbabilityData	unknown(double probability) Returns a branch profile object with an unknown source and the given designated successor probability.

Methods inherited from class org.graalvm.compiler.nodes.ProfileData

getProfileSource

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

create

public static ProfileData.BranchProbabilityData create(double designatedSuccessorProbability,
                                                       ProfileData.ProfileSource profileSource)

Returns a profile data object with the given designated successor probability and profile source.

getDesignatedSuccessorProbability

public double getDesignatedSuccessorProbability()

getNegatedProbability

public double getNegatedProbability()

copy

public ProfileData.BranchProbabilityData copy(double newProbability)

negated

public ProfileData.BranchProbabilityData negated()

injected

public static ProfileData.BranchProbabilityData injected(double probability)

injected

public static ProfileData.BranchProbabilityData injected(double probability,
                                                         boolean negated)

profiled

public static ProfileData.BranchProbabilityData profiled(double probability)

unknown

public static ProfileData.BranchProbabilityData unknown()

Returns a singleton branch profile object with an unknown source and designated successor probability 0.5.

unknown

public static ProfileData.BranchProbabilityData unknown(double probability)

Returns a branch profile object with an unknown source and the given designated successor probability. Most users should use ProfileData.BranchProbabilityData.unknown() instead to get a profile object with equal successor probabilities.

combineShortCircuitOr

public static ProfileData.BranchProbabilityData combineShortCircuitOr(ProfileData.BranchProbabilityData a,
                                                                      ProfileData.BranchProbabilityData b)

Computes combined profile data for short-circuiting evaluation of a || b.

combineAndWithNegated

public ProfileData.BranchProbabilityData combineAndWithNegated(ProfileData.BranchProbabilityData other)

Computes combined profile data for not short-circuiting evaluation of this && !other.

toString

public String toString()

Overrides:

toString in class Object