smile.data.formula

Interface Terms

public interface Terms

Predefined terms.

Method Summary

Modifier and Type	Method and Description
static Term	$(java.lang.String x) Returns a variable.
static Abs	abs(java.lang.String x) Applies Math.abs.
static Abs	abs(Term x) Applies Math.abs.
static DoubleFunction	acos(java.lang.String x) Applies Math.acos.
static DoubleFunction	acos(Term x) Applies Math.acos.
static Term	add(java.lang.String a, java.lang.String b) Adds two terms.
static Term	add(java.lang.String a, Term b) Adds two terms.
static Term	add(Term a, java.lang.String b) Adds two terms.
static Term	add(Term a, Term b) Adds two terms.
static DoubleFunction	asin(java.lang.String x) Applies Math.asin.
static DoubleFunction	asin(Term x) Applies Math.asin.
static DoubleFunction	atan(java.lang.String x) Applies Math.atan.
static DoubleFunction	atan(Term x) Applies Math.atan.
static DoubleFunction	cbrt(java.lang.String x) Applies Math.cbrt.
static DoubleFunction	cbrt(Term x) Applies Math.cbrt.
static DoubleFunction	ceil(java.lang.String x) Applies Math.ceil.
static DoubleFunction	ceil(Term x) Applies Math.ceil.
static DoubleFunction	cos(java.lang.String x) Applies Math.cos.
static DoubleFunction	cos(Term x) Applies Math.cos.
static DoubleFunction	cosh(java.lang.String x) Applies Math.cosh.
static DoubleFunction	cosh(Term x) Applies Math.cosh.
static smile.data.formula.FactorCrossing	cross(int order, java.lang.String... factors) Factor crossing of two or more factors.
static smile.data.formula.FactorCrossing	cross(java.lang.String... factors) Factor crossing of two or more factors.
static Date	date(java.lang.String x, DateFeature... features) Extracts date/time features.
static Term	delete(java.lang.String x) Deletes a variable or the intercept ("1") from the formula.
static Term	delete(Term x) Deletes a term from the formula.
static Term	div(java.lang.String a, java.lang.String b) Divides two terms.
static Term	div(java.lang.String a, Term b) Divides two terms.
static Term	div(Term a, java.lang.String b) Divides two terms.
static Term	div(Term a, Term b) Divides two terms.
static smile.data.formula.Dot	dot() Returns the special term "." that means all columns not otherwise in the formula in the context of a data frame.
static DoubleFunction	exp(java.lang.String x) Applies Math.exp.
static DoubleFunction	exp(Term x) Applies Math.exp.
static DoubleFunction	expm1(java.lang.String x) Applies Math.expm1.
static DoubleFunction	expm1(Term x) Applies Math.expm1.
static DoubleFunction	floor(java.lang.String x) Applies Math.floor.
static DoubleFunction	floor(Term x) Applies Math.floor.
static FactorInteraction	interact(java.lang.String... factors) Factor interaction of two or more factors.
static DoubleFunction	log(java.lang.String x) Applies Math.log.
static DoubleFunction	log(Term x) Applies Math.log.
static DoubleFunction	log10(java.lang.String x) Applies Math.log10.
static DoubleFunction	log10(Term x) Applies Math.log10.
static DoubleFunction	log1p(java.lang.String x) Applies Math.log1p.
static DoubleFunction	log1p(Term x) Applies Math.log1p.
static DoubleFunction	log2(java.lang.String x) Applies MathEx.log2.
static DoubleFunction	log2(Term x) Applies MathEx.log2.
static Term	mul(java.lang.String a, java.lang.String b) Multiplies two terms.
static Term	mul(java.lang.String a, Term b) Multiplies two terms.
static Term	mul(Term a, java.lang.String b) Multiplies two terms.
static Term	mul(Term a, Term b) Multiplies two terms.
static <T,R> Term	of(java.lang.String name, java.lang.String x, java.lang.Class<R> clazz, java.util.function.Function f) Returns a term that applies a lambda on given variable.
static <T,U,R> Term	of(java.lang.String name, java.lang.String x, java.lang.String y, java.lang.Class<R> clazz, java.util.function.BiFunction<T,U,R> f) Returns a term that applies a lambda on given variables.
static <T,U> Term	of(java.lang.String name, java.lang.String x, java.lang.String y, java.util.function.ToDoubleBiFunction<T,U> f) Returns a term that applies a lambda on given variables.
static <T,U> Term	of(java.lang.String name, java.lang.String x, java.lang.String y, java.util.function.ToIntBiFunction<T,U> f) Returns a term that applies a lambda on given variables.
static <T,U> Term	of(java.lang.String name, java.lang.String x, java.lang.String y, java.util.function.ToLongBiFunction<T,U> f) Returns a term that applies a lambda on given variables.
static <T> Term	of(java.lang.String name, java.lang.String x, java.util.function.ToDoubleFunction<T> f) Returns a term that applies a lambda on given variable.
static <T> Term	of(java.lang.String name, java.lang.String x, java.util.function.ToIntFunction<T> f) Returns a term that applies a lambda on given variable.
static <T> Term	of(java.lang.String name, java.lang.String x, java.util.function.ToLongFunction<T> f) Returns a term that applies a lambda on given variable.
static <T,R> Term	of(java.lang.String name, Term x, java.lang.Class<R> clazz, java.util.function.Function f) Returns a term that applies a lambda on given term.
static <T,U,R> Term	of(java.lang.String name, Term x, Term y, java.lang.Class<R> clazz, java.util.function.BiFunction<T,U,R> f) Returns a term that applies a lambda on given terms.
static <T,U> Term	of(java.lang.String name, Term x, Term y, java.util.function.ToDoubleBiFunction<T,U> f) Returns a term that applies a lambda on given terms.
static <T,U> Term	of(java.lang.String name, Term x, Term y, java.util.function.ToIntBiFunction<T,U> f) Returns a term that applies a lambda on given terms.
static <T,U> Term	of(java.lang.String name, Term x, Term y, java.util.function.ToLongBiFunction<T,U> f) Returns a term that applies a lambda on given terms.
static <T> Term	of(java.lang.String name, Term x, java.util.function.ToDoubleFunction<T> f) Returns a term that applies a lambda on given term.
static <T> Term	of(java.lang.String name, Term x, java.util.function.ToIntFunction<T> f) Returns a term that applies a lambda on given term.
static <T> Term	of(java.lang.String name, Term x, java.util.function.ToLongFunction<T> f) Returns a term that applies a lambda on given term.
static DoubleFunction	rint(java.lang.String x) Applies Math.rint.
static DoubleFunction	rint(Term x) Applies Math.rint.
static smile.data.formula.Round	round(java.lang.String x) Applies Math.round.
static smile.data.formula.Round	round(Term x) Applies Math.round.
static IntFunction	sign(java.lang.String x) Applies Integer.signum.
static IntFunction	sign(Term x) Applies Integer.signum.
static DoubleFunction	signum(java.lang.String x) Applies Math.signum.
static DoubleFunction	signum(Term x) Applies Math.signum.
static DoubleFunction	sin(java.lang.String x) Applies Math.sin.
static DoubleFunction	sin(Term x) Applies Math.sin.
static DoubleFunction	sinh(java.lang.String x) Applies Math.sinh.
static DoubleFunction	sinh(Term x) Applies Math.sinh.
static DoubleFunction	sqrt(java.lang.String x) Applies Math.sqrt.
static DoubleFunction	sqrt(Term x) Applies Math.sqrt.
static Term	sub(java.lang.String a, java.lang.String b) Subtracts two terms.
static Term	sub(java.lang.String a, Term b) Subtracts two terms.
static Term	sub(Term a, java.lang.String b) Subtracts two terms.
static Term	sub(Term a, Term b) Subtracts two terms.
static DoubleFunction	tan(java.lang.String x) Applies Math.tan.
static DoubleFunction	tan(Term x) Applies Math.tan.
static DoubleFunction	tanh(java.lang.String x) Applies Math.tanh.
static DoubleFunction	tanh(Term x) Applies Math.tanh.
static DoubleFunction	ulp(java.lang.String x) Applies Math.ulp.
static DoubleFunction	ulp(Term x) Applies Math.ulp.
static Term	val(boolean x) Returns a constant boolean term.
static Term	val(byte x) Returns a constant byte term.
static Term	val(char x) Returns a constant char term.
static Term	val(double x) Returns a constant double term.
static Term	val(float x) Returns a constant float term.
static Term	val(int x) Returns a constant integer term.
static Term	val(long x) Returns a constant long term.
static Term	val(java.lang.Object x) Returns a constant object term.
static Term	val(short x) Returns a constant short term.

Method Detail

$

static Term $(java.lang.String x)

Returns a variable.

dot

static smile.data.formula.Dot dot()

Returns the special term "." that means all columns not otherwise in the formula in the context of a data frame.

interact

static FactorInteraction interact(java.lang.String... factors)

Factor interaction of two or more factors.

cross

static smile.data.formula.FactorCrossing cross(java.lang.String... factors)

Factor crossing of two or more factors.

cross

static smile.data.formula.FactorCrossing cross(int order,
                                               java.lang.String... factors)

Factor crossing of two or more factors.

delete

static Term delete(java.lang.String x)

Deletes a variable or the intercept ("1") from the formula.

delete

static Term delete(Term x)

Deletes a term from the formula.

date

static Date date(java.lang.String x,
                 DateFeature... features)

Extracts date/time features.

add

static Term add(Term a,
                Term b)

Adds two terms.

add

static Term add(java.lang.String a,
                java.lang.String b)

Adds two terms.

add

static Term add(Term a,
                java.lang.String b)

Adds two terms.

add

static Term add(java.lang.String a,
                Term b)

Adds two terms.

sub

static Term sub(Term a,
                Term b)

Subtracts two terms.

sub

static Term sub(java.lang.String a,
                java.lang.String b)

Subtracts two terms.

sub

static Term sub(Term a,
                java.lang.String b)

Subtracts two terms.

sub

static Term sub(java.lang.String a,
                Term b)

Subtracts two terms.

mul

static Term mul(Term a,
                Term b)

Multiplies two terms.

mul

static Term mul(java.lang.String a,
                java.lang.String b)

Multiplies two terms.

mul

static Term mul(Term a,
                java.lang.String b)

Multiplies two terms.

mul

static Term mul(java.lang.String a,
                Term b)

Multiplies two terms.

div

static Term div(Term a,
                Term b)

Divides two terms.

div

static Term div(java.lang.String a,
                java.lang.String b)

Divides two terms.

div

static Term div(Term a,
                java.lang.String b)

Divides two terms.

div

static Term div(java.lang.String a,
                Term b)

Divides two terms.

abs

static Abs abs(java.lang.String x)

Applies Math.abs.

abs

static Abs abs(Term x)

Applies Math.abs.

ceil

static DoubleFunction ceil(java.lang.String x)

Applies Math.ceil.

ceil

static DoubleFunction ceil(Term x)

Applies Math.ceil.

floor

static DoubleFunction floor(java.lang.String x)

Applies Math.floor.

floor

static DoubleFunction floor(Term x)

Applies Math.floor.

round

static smile.data.formula.Round round(java.lang.String x)

Applies Math.round.

round

static smile.data.formula.Round round(Term x)

Applies Math.round.

rint

static DoubleFunction rint(java.lang.String x)

Applies Math.rint.

rint

static DoubleFunction rint(Term x)

Applies Math.rint.

exp

static DoubleFunction exp(java.lang.String x)

Applies Math.exp.

exp

static DoubleFunction exp(Term x)

Applies Math.exp.

expm1

static DoubleFunction expm1(java.lang.String x)

Applies Math.expm1.

expm1

static DoubleFunction expm1(Term x)

Applies Math.expm1.

log

static DoubleFunction log(java.lang.String x)

Applies Math.log.

log

static DoubleFunction log(Term x)

Applies Math.log.

log1p

static DoubleFunction log1p(java.lang.String x)

Applies Math.log1p.

log1p

static DoubleFunction log1p(Term x)

Applies Math.log1p.

log10

static DoubleFunction log10(java.lang.String x)

Applies Math.log10.

log10

static DoubleFunction log10(Term x)

Applies Math.log10.

log2

static DoubleFunction log2(java.lang.String x)

Applies MathEx.log2.

log2

static DoubleFunction log2(Term x)

Applies MathEx.log2.

signum

static DoubleFunction signum(java.lang.String x)

Applies Math.signum.

signum

static DoubleFunction signum(Term x)

Applies Math.signum.

sign

static IntFunction sign(java.lang.String x)

Applies Integer.signum.

sign

static IntFunction sign(Term x)

Applies Integer.signum.

sqrt

static DoubleFunction sqrt(java.lang.String x)

Applies Math.sqrt.

sqrt

static DoubleFunction sqrt(Term x)

Applies Math.sqrt.

cbrt

static DoubleFunction cbrt(java.lang.String x)

Applies Math.cbrt.

cbrt

static DoubleFunction cbrt(Term x)

Applies Math.cbrt.

sin

static DoubleFunction sin(java.lang.String x)

Applies Math.sin.

sin

static DoubleFunction sin(Term x)

Applies Math.sin.

cos

static DoubleFunction cos(java.lang.String x)

Applies Math.cos.

cos

static DoubleFunction cos(Term x)

Applies Math.cos.

tan

static DoubleFunction tan(java.lang.String x)

Applies Math.tan.

tan

static DoubleFunction tan(Term x)

Applies Math.tan.

sinh

static DoubleFunction sinh(java.lang.String x)

Applies Math.sinh.

sinh

static DoubleFunction sinh(Term x)

Applies Math.sinh.

cosh

static DoubleFunction cosh(java.lang.String x)

Applies Math.cosh.

cosh

static DoubleFunction cosh(Term x)

Applies Math.cosh.

tanh

static DoubleFunction tanh(java.lang.String x)

Applies Math.tanh.

tanh

static DoubleFunction tanh(Term x)

Applies Math.tanh.

asin

static DoubleFunction asin(java.lang.String x)

Applies Math.asin.

asin

static DoubleFunction asin(Term x)

Applies Math.asin.

acos

static DoubleFunction acos(java.lang.String x)

Applies Math.acos.

acos

static DoubleFunction acos(Term x)

Applies Math.acos.

atan

static DoubleFunction atan(java.lang.String x)

Applies Math.atan.

atan

static DoubleFunction atan(Term x)

Applies Math.atan.

ulp

static DoubleFunction ulp(java.lang.String x)

Applies Math.ulp.

ulp

static DoubleFunction ulp(Term x)

Applies Math.ulp.

val

static Term val(boolean x)

Returns a constant boolean term.

val

static Term val(char x)

Returns a constant char term.

val

static Term val(byte x)

Returns a constant byte term.

val

static Term val(short x)

Returns a constant short term.

val

static Term val(int x)

Returns a constant integer term.

val

static Term val(long x)

Returns a constant long term.

val

static Term val(float x)

Returns a constant float term.

val

static Term val(double x)

Returns a constant double term.

val

static Term val(java.lang.Object x)

Returns a constant object term.

of

static <T> Term of(java.lang.String name,
                   java.lang.String x,
                   java.util.function.ToIntFunction<T> f)

Returns a term that applies a lambda on given variable.

Parameters:

name - the function name.

x - the variable name.

f - the lambda to apply on the variable.

of

static <T> Term of(java.lang.String name,
                   Term x,
                   java.util.function.ToIntFunction<T> f)

Returns a term that applies a lambda on given term.

Parameters:

name - the function name.

x - the term.

f - the lambda to apply on the term.

of

static <T> Term of(java.lang.String name,
                   java.lang.String x,
                   java.util.function.ToLongFunction<T> f)

Returns a term that applies a lambda on given variable.

Parameters:

name - the function name.

x - the variable name.

f - the lambda to apply on the variable.

of

static <T> Term of(java.lang.String name,
                   Term x,
                   java.util.function.ToLongFunction<T> f)

Returns a term that applies a lambda on given term.

Parameters:

name - the function name.

x - the term.

f - the lambda to apply on the term.

of

static <T> Term of(java.lang.String name,
                   java.lang.String x,
                   java.util.function.ToDoubleFunction<T> f)

Returns a term that applies a lambda on given variable.

Parameters:

name - the function name.

x - the variable name.

f - the lambda to apply on the variable.

of

static <T> Term of(java.lang.String name,
                   Term x,
                   java.util.function.ToDoubleFunction<T> f)

Returns a term that applies a lambda on given term.

Parameters:

name - the function name.

x - the term.

f - the lambda to apply on the term.

of

static <T,R> Term of(java.lang.String name,
                     java.lang.String x,
                     java.lang.Class<R> clazz,
                     java.util.function.Function f)

Returns a term that applies a lambda on given variable.

Parameters:

name - the function name.

x - the variable name.

clazz - the class of return object.

f - the lambda to apply on the variable.

of

static <T,R> Term of(java.lang.String name,
                     Term x,
                     java.lang.Class<R> clazz,
                     java.util.function.Function f)

Returns a term that applies a lambda on given term.

Parameters:

name - the function name.

x - the term.

clazz - the class of return object.

f - the lambda to apply on the term.

of

static <T,U> Term of(java.lang.String name,
                     java.lang.String x,
                     java.lang.String y,
                     java.util.function.ToIntBiFunction<T,U> f)

Returns a term that applies a lambda on given variables.

Parameters:

name - the function name.

x - the first parameter of function.

y - the second parameter of function.

f - the lambda to apply on the variables.

of

static <T,U> Term of(java.lang.String name,
                     Term x,
                     Term y,
                     java.util.function.ToIntBiFunction<T,U> f)

Returns a term that applies a lambda on given terms.

Parameters:

name - the function name.

x - the first parameter of function.

y - the second parameter of function.

f - the lambda to apply on the terms.

of

static <T,U> Term of(java.lang.String name,
                     java.lang.String x,
                     java.lang.String y,
                     java.util.function.ToLongBiFunction<T,U> f)

Returns a term that applies a lambda on given variables.

Parameters:

name - the function name.

x - the first parameter of function.

y - the second parameter of function.

f - the lambda to apply on the variables.

of

static <T,U> Term of(java.lang.String name,
                     Term x,
                     Term y,
                     java.util.function.ToLongBiFunction<T,U> f)

Returns a term that applies a lambda on given terms.

Parameters:

name - the function name.

x - the first parameter of function.

y - the second parameter of function.

f - the lambda to apply on the terms.

of

static <T,U> Term of(java.lang.String name,
                     java.lang.String x,
                     java.lang.String y,
                     java.util.function.ToDoubleBiFunction<T,U> f)

Returns a term that applies a lambda on given variables.

Parameters:

name - the function name.

x - the first parameter of function.

y - the second parameter of function.

f - the lambda to apply on the variables.

of

static <T,U> Term of(java.lang.String name,
                     Term x,
                     Term y,
                     java.util.function.ToDoubleBiFunction<T,U> f)

Returns a term that applies a lambda on given terms.

Parameters:

name - the function name.

x - the first parameter of function.

y - the second parameter of function.

f - the lambda to apply on the terms.

of

static <T,U,R> Term of(java.lang.String name,
                       java.lang.String x,
                       java.lang.String y,
                       java.lang.Class<R> clazz,
                       java.util.function.BiFunction<T,U,R> f)

Returns a term that applies a lambda on given variables.

Parameters:

name - the function name.

x - the first parameter of function.

y - the second parameter of function.

clazz - the class of return object.

f - the lambda to apply on the variables.

of

static <T,U,R> Term of(java.lang.String name,
                       Term x,
                       Term y,
                       java.lang.Class<R> clazz,
                       java.util.function.BiFunction<T,U,R> f)

Returns a term that applies a lambda on given terms.

Parameters:

name - the function name.

x - the first parameter of function.

y - the second parameter of function.

clazz - the class of return object.

f - the lambda to apply on the terms.