jscicalc.Substitution Class Reference

This class allows us to set up a substitution so that we can substitute variables in an OObject with arbitrary values. More...

List of all members.

Public Member Functions
	Substitution ()
	The constructor.
void	add (jscicalc.expression.Variable variable, OObject oobject)
	Add a substitution.
final java.util.LinkedList< Pair >	getSubstitutions ()
	Get substitutions.
Private Attributes
java.util.LinkedList< Pair >	substitutions
	The map containing all the substitutions.
Classes
class	Pair
	Inner class used for substitution pairs. More...

---

Detailed Description

This class allows us to set up a substitution so that we can substitute variables in an OObject with arbitrary values.

The arbitrary values are defined by another OObject.

Author:

J. D. Lamb

Version:

Revision

1.1

---

Constructor & Destructor Documentation

jscicalc.Substitution.Substitution

(

)

The constructor.

The default does nothing because it is possible to make no substitutions.

References jscicalc.Substitution.substitutions.

Referenced by jscicalc.graph.Locus.Locus().

---

Member Function Documentation

void jscicalc.Substitution.add	(	jscicalc.expression.Variable	variable,
		OObject	oobject
	)

Add a substitution.

This maps a Variable to an OObject. We regard any variable with matching name as equivalent to variable. If oobject is null, we take the addition as a request not to substiute (equivalent to but more effiecient than substituting the Variable with itself.

Parameters:

	variable	The Variable
	oobject	Its replacement

References jscicalc.expression.Variable.name(), jscicalc.Substitution.Pair.oobject, jscicalc.Substitution.substitutions, and jscicalc.Substitution.Pair.variable.

Referenced by jscicalc.graph.Locus.substitute().

final java.util.LinkedList<Pair> jscicalc.Substitution.getSubstitutions

(

)

Get substitutions.

Returns:

list of substitutions

References jscicalc.Substitution.substitutions.

---

Member Data Documentation

java.util.LinkedList<Pair> jscicalc.Substitution.substitutions [private]

The map containing all the substitutions.

Referenced by jscicalc.Substitution.add(), jscicalc.Substitution.getSubstitutions(), and jscicalc.Substitution.Substitution().

---

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

• Substitution.java