Package org.djutils.eval

Class F1

java.lang.Object

org.djutils.eval.F1

All Implemented Interfaces:

org.djutils.base.Identifiable, Function

class F1
extends Object
implements Function

F1.java. Minimal implementation of one-argument Function with description.

Copyright (c) 2023-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://djutils.org. The DJUTILS project is distributed under a three-clause BSD-style license, which can be found at https://djutils.org/docs/license.html.

Author:

Peter Knoppers

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static interface	F1.OneArgumentFunction	Interface for one argument functions.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) final F1.OneArgumentFunction	f1	The zero argument function.
(package private) final String	id	Id of the function.
(package private) final org.djutils.metadata.MetaData	metaData	Type of the parameters of this function (also contains name and description).
(package private) final Class<?>	resultClass	Type of the result of this function.

Constructor Summary

Constructors

Constructor	Description
F1(String id, Class<?> resultClass, org.djutils.metadata.MetaData metaData, F1.OneArgumentFunction f1)	Construct a new one-argument function.

Method Summary

Modifier and Type	Method	Description
Object	function(Object[] arguments)	The function itself.
String	getId()
org.djutils.metadata.MetaData	getMetaData()	Specifies the types of the arguments expected by the function.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.djutils.eval.Function

getDescription, getName

Field Details

id

final String id

Id of the function.

metaData

final org.djutils.metadata.MetaData metaData

Type of the parameters of this function (also contains name and description).

resultClass

final Class<?> resultClass

Type of the result of this function.

f1

final F1.OneArgumentFunction f1

The zero argument function.

Constructor Details

F1

F1(String id,
 Class<?> resultClass,
 org.djutils.metadata.MetaData metaData,
 F1.OneArgumentFunction f1)

Construct a new one-argument function.

Parameters:

id - String; name of the function as it must be written in expressions

resultClass - Class<?>; the type of the result of the function

metaData - MetaData; meta data of the function

f1 - OneArgumentFunction; one argument function

Method Details

getId

public String getId()

Specified by:

getId in interface org.djutils.base.Identifiable

getMetaData

public org.djutils.metadata.MetaData getMetaData()

Description copied from interface: Function

Specifies the types of the arguments expected by the function.

Specified by:

getMetaData in interface Function

Returns:

MetaData; specification of the arguments expected by the function

function

public Object function(Object[] arguments)
                throws RuntimeException

Description copied from interface: Function

The function itself.

Specified by:

function in interface Function

Parameters:

arguments - Object[]; the arguments of the function

Returns:

Object; the result of the function (must currently be either some type of DoubleScalar or Boolean).

Throws:

RuntimeException - thrown when the function is unable to produce a result