Kirk Rader  1.0-SNAPSHOT
Public Member Functions | Protected Member Functions | List of all members
us.rader.tt.formula.Description Class Reference

Definite description (reverse iota). More...

Inheritance diagram for us.rader.tt.formula.Description:
Inheritance graph

Public Member Functions

 Description (final Variable variable, final Formula formula)
 
Set< ExpressiongetNodes ()
 
Set< ExpressiongetTerminalNodes ()
 
Expression replaceVariable (final Variable boundVariable, final Expression factor)
 TODO: Think through rules for enforcing choice of new variables and accidental capture. More...
 
- Public Member Functions inherited from us.rader.tt.formula.VariableBindingOperator
final boolean evaluate (final Map< Expression, Boolean > values)
 
Set< ExpressiongetTerminalNodes ()
 
final Formula instantiate (final Expression factor)
 Return the Formula that results from instantiating this operator. More...
 
void printDigraph (final PrintStream stream, final int indent)
 
final void toLaTeX (final PrintStream stream)
 
final String toString ()
 
- Public Member Functions inherited from us.rader.tt.formula.Operator
Set< ExpressiongetNodes ()
 
Set< ExpressiongetTerminalNodes ()
 
void printDigraph (final PrintStream stream, final int indent)
 
- Public Member Functions inherited from us.rader.tt.formula.Formula
abstract boolean evaluate (Map< Expression, Boolean > values)
 Evaluate this formula according to its truth table assuming the given values for its primitive terms. More...
 
final String toDigraph (final int indent) throws IOException
 
final void toDigraph (final PrintStream stream, final int indent)
 Write this formula's syntax tree as a Graphviz digraph. More...
 
final String toTruthTable (final int indent) throws IOException
 
final void toTruthTable (final PrintStream stream, final int indent) throws IOException
 Print this formula's truth table in LaTeX format to the given output stream. More...
 
- Public Member Functions inherited from us.rader.tt.formula.Expression
final boolean equals (final Object obj)
 Base equality on the string representation of a formula. More...
 
abstract Set< ExpressiongetNodes ()
 
abstract Set< ExpressiongetTerminalNodes ()
 
final int hashCode ()
 Base the hash code on the string representation of a formula. More...
 
abstract Expression replaceVariable (Variable boundVariable, Expression factor)
 Replace boundVariable with factor everywhere in this Expression. More...
 
final String toLaTeX () throws IOException
 
abstract void toLaTeX (PrintStream stream)
 Print the LaTeX representation of this object to the given stream. More...
 

Protected Member Functions

String getOperator ()
 
void printLaTeXOperator (final PrintStream stream)
 
- Protected Member Functions inherited from us.rader.tt.formula.VariableBindingOperator
 VariableBindingOperator (final Variable variable, final Formula operand)
 Initialize variable and Operator. More...
 
- Protected Member Functions inherited from us.rader.tt.formula.Operator
 Operator (final Formula... operands)
 
abstract String getOperator ()
 
abstract void printLaTeXOperator (PrintStream stream)
 
- Protected Member Functions inherited from us.rader.tt.formula.Expression
 Expression ()
 Initialize nodeName. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from us.rader.tt.formula.Formula
static Formula parseFormula (final BufferedReader reader) throws IOException
 Parse the next Formula from the given buffered input stream. More...
 
static Formula parseFormula (final InputStream stream) throws IOException
 Parse the next Formula from the given input stream. More...
 
static Formula parseFormula (final String formula) throws IOException
 Parse the the given term. More...
 
- Static Public Member Functions inherited from us.rader.tt.formula.Expression
static Expression parseFactor (final BufferedReader reader) throws IOException
 Parse the next Expression from the given buffered input stream. More...
 
static Expression parseFactor (final InputStream stream) throws IOException
 Parse the next Expression from the given buffered input stream. More...
 
static Expression parseFactor (final String factor) throws IOException
 Parse the next Expression from the given buffered input stream. More...
 
- Static Protected Member Functions inherited from us.rader.tt.formula.Expression
static Expression parseVariableBindingOperator (final BufferedReader reader, final Class<? extends VariableBindingOperator > type, final char terminator) throws IOException
 Parse the next VariableBindingOperator or Description from the given buffered input stream. More...
 
static void printIndentation (final PrintStream stream, final int indent)
 Print the specified number of spaces to the given stream. More...
 
static int skipWhitespace (final BufferedReader reader) throws IOException
 Discard white space from the given buffered input stream. More...
 
- Protected Attributes inherited from us.rader.tt.formula.VariableBindingOperator
Variable variable
 The variable bound by this operator. More...
 
- Protected Attributes inherited from us.rader.tt.formula.Operator
List< Formulaoperands
 The connective's operands. More...
 
- Protected Attributes inherited from us.rader.tt.formula.Expression
String nodeName
 Graphviz digraph node name. More...
 
- Static Package Functions inherited from us.rader.tt.formula.Expression
 [static initializer]
 

Detailed Description

Definite description (reverse iota).

Definition at line 26 of file Description.java.

Constructor & Destructor Documentation

◆ Description()

us.rader.tt.formula.Description.Description ( final Variable  variable,
final Formula  formula 
)
Parameters
variableThe bound Variable
formulaThe Formula in which variable is bound

Definition at line 35 of file Description.java.

Referenced by us.rader.tt.formula.Description.replaceVariable().

35  {
36 
37  super(variable, formula);
38 
39  }
Variable variable
The variable bound by this operator.

Member Function Documentation

◆ getNodes()

Set<Expression> us.rader.tt.formula.Description.getNodes ( )
See also
Expression::getNodes

Definition at line 45 of file Description.java.

References us.rader.tt.formula.Operator.operands.

45  {
46 
47  final Set<Expression> nodes = new HashSet<>();
48  nodes.addAll(operands.get(0).getNodes());
49  return nodes;
50 
51  }
List< Formula > operands
The connective&#39;s operands.
Definition: Operator.java:33

◆ getOperator()

String us.rader.tt.formula.Description.getOperator ( )
protected
See also
VariableBindingOperator::getOperator

Definition at line 84 of file Description.java.

References us.rader.tt.formula.Variable.toString(), and us.rader.tt.formula.VariableBindingOperator.variable.

84  {
85 
86  return ":" + variable.toString() + ":";
87 
88  }
Variable variable
The variable bound by this operator.

◆ getTerminalNodes()

Set<Expression> us.rader.tt.formula.Description.getTerminalNodes ( )
See also
Expression::getTerminalNodes

Definition at line 57 of file Description.java.

57  {
58 
59  final Set<Expression> nodes = new HashSet<>();
60  nodes.add(this);
61  return nodes;
62 
63  }

◆ printLaTeXOperator()

void us.rader.tt.formula.Description.printLaTeXOperator ( final PrintStream  stream)
protected
See also
VariableBindingOperator::printLaTeXOperator

Definition at line 94 of file Description.java.

References us.rader.tt.formula.Variable.toLaTeX(), and us.rader.tt.formula.VariableBindingOperator.variable.

94  {
95 
96  stream.print("\\riota ");
97  variable.toLaTeX(stream);
98  stream.print(' ');
99 
100  }
void toLaTeX(final PrintStream stream)
Definition: Variable.java:98
Variable variable
The variable bound by this operator.

◆ replaceVariable()

Expression us.rader.tt.formula.Description.replaceVariable ( final Variable  boundVariable,
final Expression  factor 
)

TODO: Think through rules for enforcing choice of new variables and accidental capture.

For now, rely on the caller to have made a sensible choice...

See also
Expression::replaceVariable

Definition at line 74 of file Description.java.

References us.rader.tt.formula.Description.Description(), us.rader.tt.formula.Operator.operands, and us.rader.tt.formula.VariableBindingOperator.variable.

74  {
75 
76  return new Description(variable, (Formula) operands.get(0).replaceVariable(boundVariable, factor));
77 
78  }
Description(final Variable variable, final Formula formula)
List< Formula > operands
The connective&#39;s operands.
Definition: Operator.java:33
Variable variable
The variable bound by this operator.

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