Token

A token in a non-linear formula. More...

#include <xpress_objects.hpp>

Public Member Functions
	Token ()

auto	compareTo (Token const &other) const -> int

auto	equals (Token const &other) const -> bool

auto	getHashCode () const -> std::size_t

auto	getType () const -> int
	Token type [get].

auto	getValue () const -> double
	Token value [get].

auto	operator!= (Token const &other) const -> bool

auto	operator== (Token const &other) const -> bool

auto	toString () const -> std::string

Static Public Member Functions
static auto	column (int col) -> xpress::objects::Token
	Create a token that represents a reference to column `col`.

static auto	constant (double value) -> xpress::objects::Token
	Create a token that represents the constant value `value`.

static auto	function (int id) -> xpress::objects::Token
	Create a token that represents a call to user function `id`.

static auto	internalFunction (int id) -> xpress::objects::Token
	Create a token that represents a call to internal function `id`.

static auto	of (int type, double value) -> xpress::objects::Token
	Create a token from a type and a value.

Static Public Attributes
static constexpr Token const &	ABS = xpress::GlobalConstants<void>::xpress_objects_Token_ABS
	`abs` function.

static constexpr Token const &	ARCCOS = xpress::GlobalConstants<void>::xpress_objects_Token_ARCCOS
	`arccos` function.

static constexpr Token const &	ARCSIN = xpress::GlobalConstants<void>::xpress_objects_Token_ARCSIN
	`arcsin` function.

static constexpr Token const &	ARCTAN = xpress::GlobalConstants<void>::xpress_objects_Token_ARCTAN
	`arctan` function.

static constexpr Token const &	COLON = xpress::GlobalConstants<void>::xpress_objects_Token_COLON
	Colon token.

static constexpr Token const &	COMMA = xpress::GlobalConstants<void>::xpress_objects_Token_COMMA
	Comma token.

static constexpr Token const &	COS = xpress::GlobalConstants<void>::xpress_objects_Token_COS
	`cos` function.

static constexpr Token const &	DIVIDE = xpress::GlobalConstants<void>::xpress_objects_Token_DIVIDE
	Divide token.

static constexpr Token const &	EOFORMULA = xpress::GlobalConstants<void>::xpress_objects_Token_EOF
	End of formula token.

static constexpr Token const &	EXP = xpress::GlobalConstants<void>::xpress_objects_Token_EXP
	`exp` function.

static constexpr Token const &	EXPONENT = xpress::GlobalConstants<void>::xpress_objects_Token_EXPONENT
	Exponentiation token.

static constexpr Token const &	LB = xpress::GlobalConstants<void>::xpress_objects_Token_LB
	Left-bracket token.

static constexpr Token const &	LN = xpress::GlobalConstants<void>::xpress_objects_Token_LN
	`ln` function.

static constexpr Token const &	LOG10 = xpress::GlobalConstants<void>::xpress_objects_Token_LOG10
	`log10` function.

static constexpr Token const &	MAX = xpress::GlobalConstants<void>::xpress_objects_Token_MAX
	`max` function.

static constexpr Token const &	MIN = xpress::GlobalConstants<void>::xpress_objects_Token_MIN
	`min` function.

static constexpr Token const &	MINUS = xpress::GlobalConstants<void>::xpress_objects_Token_MINUS
	Minus token.

static constexpr Token const &	MULTIPLY = xpress::GlobalConstants<void>::xpress_objects_Token_MULTIPLY
	Multiply token.

static constexpr Token const &	PLUS = xpress::GlobalConstants<void>::xpress_objects_Token_PLUS
	Plus token.

static constexpr Token const &	PROD = xpress::GlobalConstants<void>::xpress_objects_Token_PROD
	`prod` function.

static constexpr Token const &	PWL = xpress::GlobalConstants<void>::xpress_objects_Token_PWL
	`pwl` function.

static constexpr Token const &	RB = xpress::GlobalConstants<void>::xpress_objects_Token_RB
	Right-bracket token.

static constexpr Token const &	SIGN = xpress::GlobalConstants<void>::xpress_objects_Token_SIGN
	`sign` function.

static constexpr Token const &	SIN = xpress::GlobalConstants<void>::xpress_objects_Token_SIN
	`sin` function.

static constexpr Token const &	SQRT = xpress::GlobalConstants<void>::xpress_objects_Token_SQRT
	`sqrt` function.

static constexpr Token const &	SUM = xpress::GlobalConstants<void>::xpress_objects_Token_SUM
	`sum` function.

static constexpr Token const &	TAN = xpress::GlobalConstants<void>::xpress_objects_Token_TAN
	`tan` function.

static constexpr Token const &	UMINUS = xpress::GlobalConstants<void>::xpress_objects_Token_UMINUS
	Unary minus token.

Detailed Description

A token in a non-linear formula.

All constructors of this class are private. Use the various static factory functions to get instances. This avoids creating multiple instances that refer to the same token (like for example the EOFORMULA token.

Since: 44.00

Constructor & Destructor Documentation

Token()

xpress::objects::Token::Token ( )

inline

Since: 44.00

Member Function Documentation

column()

static auto xpress::objects::Token::column ( int col ) -> xpress::objects::Token

inlinestatic

Create a token that represents a reference to column col.

Parameters

col	Index of column to reference.

Returns: The token.

Since: 44.00

compareTo()

auto xpress::objects::Token::compareTo ( Token const & other ) const -> int

inline

Since: 44.00

constant()

static auto xpress::objects::Token::constant ( double value ) -> xpress::objects::Token

inlinestatic

Create a token that represents the constant value value.

Parameters

value Constant value that the token represents.

Returns: The token.

Since: 44.00

equals()

auto xpress::objects::Token::equals ( Token const & other ) const -> bool

inline

Since: 44.00

function()

static auto xpress::objects::Token::function ( int id ) -> xpress::objects::Token

inlinestatic

Create a token that represents a call to user function id.

Parameters

id	User function id.

Returns: The token.

Since: 44.00

getHashCode()

auto xpress::objects::Token::getHashCode ( ) const -> std::size_t

inline

Since: 44.00

getType()

auto xpress::objects::Token::getType ( ) const -> int

inline

Token type [get].

Since: 44.00

getValue()

auto xpress::objects::Token::getValue ( ) const -> double

inline

Token value [get].

Since: 44.00

internalFunction()

static auto xpress::objects::Token::internalFunction ( int id ) -> xpress::objects::Token

inlinestatic

Create a token that represents a call to internal function id.

Parameters

id	Internal function id.

Returns: The token.

Since: 44.00

of()

static auto xpress::objects::Token::of	(	int	type,
		double	value ) -> xpress::objects::Token

inlinestatic

Create a token from a type and a value.

Parameters

type	Token type.
value	Token value.

Returns: The token represented by type and value.

Since: 44.00

operator!=()

auto xpress::objects::Token::operator!= ( Token const & other ) const -> bool

inline

Since: 44.00

operator==()

auto xpress::objects::Token::operator== ( Token const & other ) const -> bool

inline

Since: 44.00

toString()

auto xpress::objects::Token::toString ( ) const -> std::string

inline

Since: 44.00

Member Data Documentation

ABS

Token const& xpress::objects::Token::ABS = xpress::GlobalConstants<void>::xpress_objects_Token_ABS

inlinestaticconstexpr

abs function.

Since: 44.00

ARCCOS

Token const& xpress::objects::Token::ARCCOS = xpress::GlobalConstants<void>::xpress_objects_Token_ARCCOS

inlinestaticconstexpr

arccos function.

Since: 44.00

ARCSIN

Token const& xpress::objects::Token::ARCSIN = xpress::GlobalConstants<void>::xpress_objects_Token_ARCSIN

inlinestaticconstexpr

arcsin function.

Since: 44.00

ARCTAN

Token const& xpress::objects::Token::ARCTAN = xpress::GlobalConstants<void>::xpress_objects_Token_ARCTAN

inlinestaticconstexpr

arctan function.

Since: 44.00

COLON

Token const& xpress::objects::Token::COLON = xpress::GlobalConstants<void>::xpress_objects_Token_COLON

inlinestaticconstexpr

Colon token.

Since: 44.00

COMMA

Token const& xpress::objects::Token::COMMA = xpress::GlobalConstants<void>::xpress_objects_Token_COMMA

inlinestaticconstexpr

Comma token.

Since: 44.00

COS

Token const& xpress::objects::Token::COS = xpress::GlobalConstants<void>::xpress_objects_Token_COS

inlinestaticconstexpr

cos function.

Since: 44.00

DIVIDE

Token const& xpress::objects::Token::DIVIDE = xpress::GlobalConstants<void>::xpress_objects_Token_DIVIDE

inlinestaticconstexpr

Divide token.

Since: 44.00

EOFORMULA

Token const& xpress::objects::Token::EOFORMULA = xpress::GlobalConstants<void>::xpress_objects_Token_EOF

inlinestaticconstexpr

End of formula token.

Since: 44.00

EXP

Token const& xpress::objects::Token::EXP = xpress::GlobalConstants<void>::xpress_objects_Token_EXP

inlinestaticconstexpr

exp function.

Since: 44.00

EXPONENT

Token const& xpress::objects::Token::EXPONENT = xpress::GlobalConstants<void>::xpress_objects_Token_EXPONENT

inlinestaticconstexpr

Exponentiation token.

Since: 44.00

LB

Token const& xpress::objects::Token::LB = xpress::GlobalConstants<void>::xpress_objects_Token_LB

inlinestaticconstexpr

Left-bracket token.

Since: 44.00

LN

Token const& xpress::objects::Token::LN = xpress::GlobalConstants<void>::xpress_objects_Token_LN

inlinestaticconstexpr

ln function.

Since: 44.00

LOG10

Token const& xpress::objects::Token::LOG10 = xpress::GlobalConstants<void>::xpress_objects_Token_LOG10

inlinestaticconstexpr

log10 function.

Since: 44.00

MAX

Token const& xpress::objects::Token::MAX = xpress::GlobalConstants<void>::xpress_objects_Token_MAX

inlinestaticconstexpr

max function.

Since: 44.00

MIN

Token const& xpress::objects::Token::MIN = xpress::GlobalConstants<void>::xpress_objects_Token_MIN

inlinestaticconstexpr

min function.

Since: 44.00

MINUS

Token const& xpress::objects::Token::MINUS = xpress::GlobalConstants<void>::xpress_objects_Token_MINUS

inlinestaticconstexpr

Minus token.

Since: 44.00

MULTIPLY

Token const& xpress::objects::Token::MULTIPLY = xpress::GlobalConstants<void>::xpress_objects_Token_MULTIPLY

inlinestaticconstexpr

Multiply token.

Since: 44.00

PLUS

Token const& xpress::objects::Token::PLUS = xpress::GlobalConstants<void>::xpress_objects_Token_PLUS

inlinestaticconstexpr

Plus token.

Since: 44.00

PROD

Token const& xpress::objects::Token::PROD = xpress::GlobalConstants<void>::xpress_objects_Token_PROD

inlinestaticconstexpr

prod function.

Since: 44.00

PWL

Token const& xpress::objects::Token::PWL = xpress::GlobalConstants<void>::xpress_objects_Token_PWL

inlinestaticconstexpr

pwl function.

Since: 44.00

RB

Token const& xpress::objects::Token::RB = xpress::GlobalConstants<void>::xpress_objects_Token_RB

inlinestaticconstexpr

Right-bracket token.

Since: 44.00

SIGN

Token const& xpress::objects::Token::SIGN = xpress::GlobalConstants<void>::xpress_objects_Token_SIGN

inlinestaticconstexpr

sign function.

Since: 44.00

SIN

Token const& xpress::objects::Token::SIN = xpress::GlobalConstants<void>::xpress_objects_Token_SIN

inlinestaticconstexpr

sin function.

Since: 44.00

SQRT

Token const& xpress::objects::Token::SQRT = xpress::GlobalConstants<void>::xpress_objects_Token_SQRT

inlinestaticconstexpr

sqrt function.

Since: 44.00

SUM

Token const& xpress::objects::Token::SUM = xpress::GlobalConstants<void>::xpress_objects_Token_SUM

inlinestaticconstexpr

sum function.

Since: 44.00

TAN

Token const& xpress::objects::Token::TAN = xpress::GlobalConstants<void>::xpress_objects_Token_TAN

inlinestaticconstexpr

tan function.

Since: 44.00

UMINUS

Token const& xpress::objects::Token::UMINUS = xpress::GlobalConstants<void>::xpress_objects_Token_UMINUS

inlinestaticconstexpr

Unary minus token.

Since: 44.00

The documentation for this class was generated from the following file:

xpress_objects.hpp

© 2001-2025 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.

Contents

Index

Glossary

Search Results

Token

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Token()

Member Function Documentation

column()

compareTo()

constant()

equals()

function()

getHashCode()

getType()

getValue()

internalFunction()

of()

operator!=()

operator==()

toString()

Member Data Documentation

ABS

ARCCOS

ARCSIN

ARCTAN

COLON

COMMA

COS

DIVIDE

EOFORMULA

EXP

EXPONENT

LB

LN

LOG10

MAX

MIN

MINUS

MULTIPLY

PLUS

PROD

PWL

RB

SIGN

SIN

SQRT

SUM

TAN

UMINUS