Class FloatField<V extends @Nullable Object>

Javadoc 27 generates this reference during each site build from the exported packages and the annotation processor. The Java guide shows the API in use.

java.lang.Object

dev.gecode.iris.Field<V>

dev.gecode.iris.build.FloatField<V>

Type Parameters:

V - the Java type of the entry's value

All Implemented Interfaces:

Domain<FloatExpr>, Expr, FloatExpr, NumericExpr

public final class FloatField<V extends @Nullable Object> extends Field<V> implements FloatExpr

A handle of a float entry. In a builder it is an expression; after reading, data.get(handle) returns the entry as V.

The factories such as Iris.float0(String) make handles that any builder may use: the first use in a builder declares the name with the handle's type, depth and presence, and Builder.build() checks every definition against them.

• Method Summary

  Modifier and Type

  Method

  Description

  FloatField<@Nullable V>

  optional()

  Returns this handle for an entry that may be absent, for which get returns null.

  protected V

  readFrom(Data data)

  Reads the entry of this handle from data.

  String

  toString()

   

  Methods inherited from class Field

  name

  Modifier and Type

  Method

  Description

  final String

  name()

  Returns the name of the entry.

  Methods inherited from class Object

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

  Methods inherited from interface Expr

  dynamic, get, get, get, get, get

  Modifier and Type

  Method

  Description

  default DynExpr

  dynamic()

  Returns this expression with no static type, which every method accepts.

  default DynExpr

  get(DynField field)

  Returns this.name, the field of the record this selects.

  default FloatExpr

  get(FloatField<?> field)

  Returns this.name, the field of the record this selects.

  default IntExpr

  get(IntField<?> field)

  Returns this.name, the field of the record this selects.

  default NumExpr

  get(NumField<?> field)

  Returns this.name, the field of the record this selects.

  default StringExpr

  get(StringField<?> field)

  Returns this.name, the field of the record this selects.

  Methods inherited from interface FloatExpr

  at, at, neg

  Modifier and Type

  Method

  Description

  default FloatExpr

  at(long index)

  Returns this[index].

  default FloatExpr

  at(IntegralExpr index)

  Returns this[index].

  default FloatExpr

  neg()

  Returns -this.

  Methods inherited from interface NumericExpr

  eq, eq, eq, ge, ge, ge, gt, gt, gt, le, le, le, lt, lt, lt, ne, ne, ne

  Modifier and Type

  Method

  Description

  default IntExpr

  eq(double other)

  Returns this == other.

  default IntExpr

  eq(long other)

  Returns this == other.

  default IntExpr

  eq(NumericExpr other)

  Returns this == other.

  default IntExpr

  ge(double other)

  Returns this >= other.

  default IntExpr

  ge(long other)

  Returns this >= other.

  default IntExpr

  ge(NumericExpr other)

  Returns this >= other.

  default IntExpr

  gt(double other)

  Returns this > other.

  default IntExpr

  gt(long other)

  Returns this > other.

  default IntExpr

  gt(NumericExpr other)

  Returns this > other.

  default IntExpr

  le(double other)

  Returns this <= other.

  default IntExpr

  le(long other)

  Returns this <= other.

  default IntExpr

  le(NumericExpr other)

  Returns this <= other.

  default IntExpr

  lt(double other)

  Returns this < other.

  default IntExpr

  lt(long other)

  Returns this < other.

  default IntExpr

  lt(NumericExpr other)

  Returns this < other.

  default IntExpr

  ne(double other)

  Returns this != other.

  default IntExpr

  ne(long other)

  Returns this != other.

  default IntExpr

  ne(NumericExpr other)

  Returns this != other.

• Method Details

  • optional

    public FloatField<@Nullable V> optional()

    Returns this handle for an entry that may be absent, for which get returns null.

    Returns:

    this handle for an entry that may be absent, for which get returns null

    Throws:

    IllegalStateException - for a handle from forward or a definition, whose presence its builder fixed

  • readFrom

    protected V readFrom(Data data)

    Description copied from class: Field

    Reads the entry of this handle from data.

    Specified by:

    readFrom in class Field<V extends @Nullable Object>

    Parameters:

    data - the data that a read produced

    Returns:

    the value of the entry, or null for an absent entry of an optional handle

  • toString

    public String toString()

    Overrides:

    toString in class Object