Variable (OpenNARS 3.0.4-SNAPSHOT API)

java.lang.Object
- org.opennars.language.Term
- - org.opennars.language.Variable

All Implemented Interfaces:

Serializable, Cloneable, Comparable<AbstractTerm>, AbstractTerm
```
public class Variable
extends Term
```
A variable term, which does not correspond to a concept

Author:

Pei Wang, Patrick Hammer

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.opennars.language.Term
  Term.TermVisitor

Field Summary

Fields
Modifier and Type	Field	Description
`private int`	`hash`
`private static int`	`MAX_CACHED_VARNAME_INDEXES`
`private Term`	`scope`
`private char`	`type`	caches the type character for faster lookup than charAt(0)
`private static CharSequence[]`	`vn1`
`private static CharSequence[]`	`vn2`
`private static CharSequence[]`	`vn3`

Fields inherited from class org.opennars.language.Term
EmptyTermArray, imagination, index_variable, SELF, SEQ_SPATIAL, SEQ_TEMPORAL, term_indices

Constructor Summary

Constructors
Modifier Constructor Description

Variable(CharSequence name)

protected Variable(CharSequence name, Term scope)
Constructor, from a given variable name

Constructors
Modifier	Constructor	Description
	`Variable(CharSequence name)`
`protected`	`Variable(CharSequence name, Term scope)`	Constructor, from a given variable name

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Variable`	`clone()`	Clone a Variable
`static int`	`compare(Variable a, Variable b)`
`int`	`compareTo(AbstractTerm that)`
`Map<Term,Integer>`	`countTermRecursively(Map<Term,Integer> map)`	Recursively count how often the terms are contained
`boolean`	`equals(Object that)`	Equal terms have identical name, though not necessarily the same reference.
`boolean`	`equalsTerm(Object that)`
`short`	`getComplexity()`	The syntactic complexity of a variable is 0, because it does not refer to any concept.
`static CharSequence`	`getName(char type, int index)`
`Term`	`getScope()`
`char`	`getType()`	Get the type of the variable
`int`	`hashCode()`	Produce a hash code for the term
`boolean`	`hasVar()`	Whether this compound term contains any variable term
`boolean`	`hasVarDep()`
`boolean`	`hasVarIndep()`
`boolean`	`hasVarQuery()`
`(package private) boolean`	`isCommon()`
`boolean`	`isConstant()`	A variable is not constant
`(package private) boolean`	`isDependentVariable()`
`(package private) boolean`	`isIndependentVariable()`
`(package private) boolean`	`isQueryVariable()`
`protected static CharSequence`	`newName(char type, int index)`
`Variable`	`setScope(Term scope, CharSequence n)`
`static boolean`	`validVariableType(char c)`

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class org.opennars.language.Term
cloneDeep, containedTemporalRelations, containsTerm, containsTermRecursively, get, get, getIsSpatial, getTemporalOrder, hasInterval, hasVar, isExecutable, isHigherOrderStatement, isSelf, name, nameInternal, operator, recurseSubtermsContainingVariables, recurseSubtermsContainingVariables, recurseTerms, setName, subjectOrPredicateIsIndependentVar, text, toSortedSet, toSortedSetArray, toString, valid

- Field Detail
  - type
```
private char type
```
    caches the type character for faster lookup than charAt(0)
  - scope
```
private Term scope
```
  - hash
```
private int hash
```
  - MAX_CACHED_VARNAME_INDEXES
```
private static final int MAX_CACHED_VARNAME_INDEXES
```
    See Also:
    
    Constant Field Values
  - vn1
```
private static final CharSequence[] vn1
```
  - vn2
```
private static final CharSequence[] vn2
```
  - vn3
```
private static final CharSequence[] vn3
```
- Constructor Detail
  - Variable
```
public Variable(CharSequence name)
```
  - Variable
```
protected Variable(CharSequence name,
                   Term scope)
```
    Constructor, from a given variable name
    
    Parameters:
    
    name - A String read from input
- Method Detail
  - setScope
```
public Variable setScope(Term scope,
                         CharSequence n)
```
  - clone
```
public Variable clone()
```
    Clone a Variable
    
    Overrides:
    
    clone in class Term
    
    Returns:
    
    The cloned Variable
  - getType
```
public char getType()
```
    Get the type of the variable
    
    Returns:
    
    The variable type
  - isConstant
```
public boolean isConstant()
```
    A variable is not constant
    
    Specified by:
    
    isConstant in interface AbstractTerm
    
    Overrides:
    
    isConstant in class Term
    
    Returns:
    
    false
  - getComplexity
```
public short getComplexity()
```
    The syntactic complexity of a variable is 0, because it does not refer to any concept.
    
    Overrides:
    
    getComplexity in class Term
    
    Returns:
    
    The complexity of the term, an integer
  - hasVar
```
public boolean hasVar()
```
    Description copied from class: Term
    
    Whether this compound term contains any variable term
    
    Specified by:
    
    hasVar in interface AbstractTerm
    
    Overrides:
    
    hasVar in class Term
    
    Returns:
    
    Whether the name contains a variable
  - hasVarIndep
```
public boolean hasVarIndep()
```
    Overrides:
    
    hasVarIndep in class Term
  - hasVarDep
```
public boolean hasVarDep()
```
    Overrides:
    
    hasVarDep in class Term
  - hasVarQuery
```
public boolean hasVarQuery()
```
    Overrides:
    
    hasVarQuery in class Term
  - equals
```
public boolean equals(Object that)
```
    Description copied from class: Term
    
    Equal terms have identical name, though not necessarily the same reference.
    
    Overrides:
    
    equals in class Term
    
    Parameters:
    
    that - The Term to be compared with the current Term
    
    Returns:
    
    Whether the two Terms are equal
  - equalsTerm
```
public boolean equalsTerm(Object that)
```
  - hashCode
```
public int hashCode()
```
    Description copied from class: Term
    
    Produce a hash code for the term
    
    Overrides:
    
    hashCode in class Term
    
    Returns:
    
    An integer hash code
  - compareTo
```
public int compareTo(AbstractTerm that)
```
    Specified by:
    
    compareTo in interface Comparable<AbstractTerm>
    
    Overrides:
    
    compareTo in class Term
    
    Parameters:
    
    that - The Term to be compared with the current Term
    
    Returns:
    
    The same as compareTo as defined on Strings
  - isQueryVariable
```
boolean isQueryVariable()
```
  - isDependentVariable
```
boolean isDependentVariable()
```
  - isIndependentVariable
```
boolean isIndependentVariable()
```
  - isCommon
```
boolean isCommon()
```
  - getScope
```
public Term getScope()
```
  - compare
```
public static int compare(Variable a,
                          Variable b)
```
  - validVariableType
```
public static boolean validVariableType(char c)
```
  - getName
```
public static CharSequence getName(char type,
                                   int index)
```
  - newName
```
protected static CharSequence newName(char type,
                                      int index)
```
  - countTermRecursively
```
public Map<Term,Integer> countTermRecursively(Map<Term,Integer> map)
```
    Description copied from class: Term
    
    Recursively count how often the terms are contained
    
    Overrides:
    
    countTermRecursively in class Term
    
    Parameters:
    
    map - The count map that will be created to count how often each term occurs
    
    Returns:
    
    The counts of the terms

Class Variable

Nested Class Summary

Nested classes/interfaces inherited from class org.opennars.language.Term

Field Summary

Fields inherited from class org.opennars.language.Term

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from class org.opennars.language.Term

Field Detail

type

scope

hash

MAX_CACHED_VARNAME_INDEXES

vn1

vn2

vn3

Constructor Detail

Variable

Variable

Method Detail

setScope

clone

getType

isConstant

getComplexity

hasVar

hasVarIndep

hasVarDep

hasVarQuery

equals

equalsTerm

hashCode

compareTo

isQueryVariable

isDependentVariable

isIndependentVariable

isCommon

getScope

compare

validVariableType

getName

newName

countTermRecursively