org.qedeq.kernel.base.module
Interface FunctionDefinition

All Superinterfaces:

NodeType

All Known Implementing Classes:

FunctionDefinitionVo

public interface FunctionDefinition

extends NodeType

Definition of function operator. This is a function constant. For example the function "x union y" or constants like the empty set.

Version:

$Revision: 1.3 $

Method Summary

String	getArgumentNumber() Get number of arguments for the defined object.
LatexList	getDescription() Get description.
String	getLatexPattern() Get LaTeX output for definition.
String	getName() This name together with getArgumentNumber() identifies a function.
Term	getTerm() Get term that defines the object.
VariableList	getVariableList() Get variable list of definition arguments.

Methods inherited from interface org.qedeq.kernel.base.module.NodeType

getAxiom, getFunctionDefinition, getPredicateDefinition, getProposition, getRule

Method Detail

getArgumentNumber

public String getArgumentNumber()

Get number of arguments for the defined object. Carries information about the argument number the defined object needs.

Returns:

Argument number.

getName

public String getName()

This name together with getArgumentNumber() identifies a function.

Returns:

Name of defined function.

getLatexPattern

public String getLatexPattern()

Get LaTeX output for definition. The replaceable arguments must are marked as "#1", "#2" and so on. For example "\mathfrak{M}(#1)"

Returns:

LaTeX pattern for definition type setting.

getVariableList

public VariableList getVariableList()

Get variable list of definition arguments.

Returns:

List of formulas or subject variables to be replaced in the LaTeX pattern. Could be null.

getTerm

public Term getTerm()

Get term that defines the object. Could be null.

Returns:

Defining term.

getDescription

public LatexList getDescription()

Get description. Only necessary if formula is not self-explanatory.

Returns:

Description.