org.deri.iris.builtins.datatype
Class ToFloatBuiltin

java.lang.Object
  org.deri.iris.builtins.AbstractBuiltin
      org.deri.iris.builtins.FunctionalBuiltin
          org.deri.iris.builtins.datatype.ConversionBuiltin
              org.deri.iris.builtins.datatype.ToFloatBuiltin

All Implemented Interfaces:

Comparable<IAtom>, IAtom, IBuiltinAtom

public class ToFloatBuiltin
extends ConversionBuiltin

Represents a data type conversion function, which converts supported data type instances to Float instances. The following data types are supported:

• Double
• Decimal
• Integer
• Boolean
• String

Field Summary

Fields inherited from class org.deri.iris.builtins.AbstractBuiltin

EMPTY_TERM

Constructor Summary

ToFloatBuiltin(ITerm... terms)
Creates a new instance of this builtin.

Method Summary

protected ITerm	convert(ITerm term) Converts the given supported data type instance to the specific data type
static IFloatTerm	toFloat(IBooleanTerm term) Converts a Boolean term to a Float term.
static IFloatTerm	toFloat(INumericTerm term) Converts a Numeric term to a Float term.
static IFloatTerm	toFloat(IStringTerm term) Converts a String term to a Float term.

Methods inherited from class org.deri.iris.builtins.datatype.ConversionBuiltin

computeResult

Methods inherited from class org.deri.iris.builtins.FunctionalBuiltin

evaluateTerms, maxUnknownVariables, testForEquality

Methods inherited from class org.deri.iris.builtins.AbstractBuiltin

compareTo, equals, evaluate, getPredicate, getTuple, hashCode, isBuiltin, isGround, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ToFloatBuiltin

public ToFloatBuiltin(ITerm... terms)

Creates a new instance of this builtin.

Parameters:

terms - The term representing the data type instance to be converted.

Method Detail

convert

protected ITerm convert(ITerm term)

Description copied from class: ConversionBuiltin

Converts the given supported data type instance to the specific data type

Specified by:

convert in class ConversionBuiltin

Returns:

The result of the conversion or null if the specified data type is not compatible.

toFloat

public static IFloatTerm toFloat(IBooleanTerm term)

Converts a Boolean term to a Float term. A Boolean term representing the value "True" is converted to a Float term representing "1.0". A Boolean term representing the value "False" is converted to a Float term representing "0.0".

Parameters:

term - The Boolean term to be converted.

Returns:

A new Float term representing the result of the conversion.

toFloat

public static IFloatTerm toFloat(INumericTerm term)

Converts a Numeric term to a Float term.

Parameters:

term - The Numeric term to be converted.

Returns:

A new Float term representing the result of the conversion.

toFloat

public static IFloatTerm toFloat(IStringTerm term)

Converts a String term to a Float term.

Parameters:

term - The String term to be converted.

Returns:

A new Float term representing the result of the conversion.