Class IntUniformDistribution

Namespace

OptunaSharp.Distributions

Assembly

OptunaSharp.dll

A uniform distribution on integers. Deprecated since Optuna 3.0.0: use IntDistribution instead.

[Obsolete("IntUniformDistribution has been deprecated in v3.0.0. This feature will be removed in v6.0.0. See https://github.com/optuna/optuna/releases/tag/v3.0.0. Use :class:`~optuna.distributions.IntDistribution` instead.")]
public class IntUniformDistribution : IntDistribution, IEquatable<BaseDistribution>

Inheritance

object

BaseDistribution

IntDistribution

IntUniformDistribution

Implements

IEquatable<BaseDistribution>

Inherited Members

IntDistribution.Log

IntDistribution.Step

IntDistribution.Low

IntDistribution.High

IntDistribution.ToExternalRepr(double)

IntDistribution.ToInternalRepr(object)

IntDistribution.Single()

IntDistribution.Equals(BaseDistribution)

IntDistribution.GetHashCode()

BaseDistribution.Equals(object)

BaseDistribution.ToString()

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Constructors

IntUniformDistribution(long, long, long)

Creates a numeric distribution and normalizes a stepped upper endpoint.

public IntUniformDistribution(long low, long high, long step = 1)

Parameters

low long

Inclusive lower endpoint of the parameter range.

high long

Inclusive upper endpoint; a stepped range may lower it to the last reachable grid point.

step long

Positive integer grid spacing; logarithmic ranges require one.

Exceptions

ValueError

The lower endpoint exceeds the upper endpoint, logarithmic bounds are nonpositive, or the step is invalid for the selected scale.