Term

java.lang.Object
- org.dalton.polyfun.Term

All Implemented Interfaces:

java.lang.Comparable<Term>
```
public class Term
extends java.lang.Object
implements java.lang.Comparable<Term>
```
An array of Atoms and a number. The Atoms are understood to be multiplied. For example: In the polynomial in x:
P(x) = 2(a_1)^3(b)x^4 - (a_2)(b_4)x^2 + 7ab + b_2
2(a_1)^3(b) is a term, and 7ab + b_2 is two terms: 7ab and b_2

Constructor Summary

Constructors
Constructor	Description
`Term()`	Default constructor.
`Term(char letter)`	Constructor sets numericalCoefficient to 1 and initializes atoms as an array of length 1.
`Term(double constant)`	Construct a constant term.
`Term(double numericalCoefficient, Atom[] atoms)`	Construct a Term with a new number and an array of Atoms.
`Term(Atom atom)`	Construct a Term that consists of one Atom.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`append(Atom atom)`	Inserts new Atom at the end of Term
`int`	`compareTo(Term t)`	Used for Arrays.sort.
`boolean`	`equals(Term term)`	Check equality between two Terms.
`Atom[]`	`getAtoms()`	Get the array of Atoms
`double`	`getNumericalCoefficient()`	Get the numerical coefficient.
`Atom[]`	`getTermAtoms()`	Deprecated. use `getAtoms()` ()} instead.
`double`	`getTermDouble()`	Deprecated. use `getNumericalCoefficient()` ()} instead.
`boolean`	`identicalTo(Term term)`	Deprecated. use `equals(Term)` instead.
`void`	`insert(Atom atom)`	Places a new Atom in the array of Atoms that make up the term.
`boolean`	`isConstantTerm()`	Checks if this is a constant term, i.e.
`boolean`	`isDouble()`	Deprecated. use `isConstantTerm()` instead.
`boolean`	`isLike(Term term)`	Tests to see if two terms have "like" (same letter & subscript) Atoms
`boolean`	`isZero()`	Checks to see of the double (and hence the Term) is zero.
`boolean`	`lessThan(Term term)`	Deprecated. Use `compareTo(Term)` instead.
`boolean`	`like(Term term)`	Deprecated. Use `isLike(Term)` instead.
`Term`	`paste(Atom atom)`	Creates a new Term with the a new Atom at the front of Term
`Term`	`place(Atom atom)`	Places a new Atom in the array of Atoms that make up the term.
`Atom`	`pop()`	Remove first Atom and return it.
`void`	`print()`	Deprecated. use `toString()` instead.
`void`	`push(Atom atom)`	Inserts new Atom at the front of Term
`void`	`reduce()`	Orders Atoms and combines like Atoms in the Array of atoms.
`void`	`setAtoms(Atom[] atoms)`	Set the array of Atoms.
`void`	`setNumericalCoefficient(double numericalCoefficient)`	Set the numericalCoefficient.
`void`	`setTerm(double num, Atom[] atoms)`	Deprecated. use `Term(double, Atom[])` ()} instead.
`void`	`setTerm(Atom[] atoms)`	Deprecated. use `setAtoms(Atom[])` ()} instead.
`void`	`setTermDouble(double num)`	Deprecated. use `setNumericalCoefficient(double)` ()} instead.
`Term`	`simplify()`	Orders Atoms and combines like Atoms in the Array of atoms.
`Term`	`snip()`	Make a new Term with the first Atom removed.
`Term`	`times(double scalar)`	Multiply Term by a scalar value.
`Term`	`times(Term term)`	Multiply Term by another Term.
`java.lang.String`	`toString()`	Composes a printable string of this term.

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

- Constructor Detail
  - Term
```
public Term()
```
    Default constructor.
    
    Since:
    
    1.0.0
  - Term
```
public Term(double constant)
```
    Construct a constant term.
    
    Parameters:
    
    constant - The constant that will be the entire term.
    
    Since:
    
    1.0.0
  - Term
```
public Term(Atom atom)
```
    Construct a Term that consists of one Atom.
    
    Parameters:
    
    atom - This will be the first and only Atom in the atoms array
    
    Since:
    
    1.0.0
  - Term
```
public Term(char letter)
```
    Constructor sets numericalCoefficient to 1 and initializes atoms as an array of length 1.
    
    Parameters:
    
    letter - The will be the letter
  - Term
```
public Term(double numericalCoefficient,
            Atom[] atoms)
```
    Construct a Term with a new number and an array of Atoms.
    
    Parameters:
    
    numericalCoefficient - The numericalCoefficient attribute
    
    atoms - Atom[] attribute
    
    Since:
    
    1.0.0
- Method Detail
  - getTermDouble
```
@Deprecated
public double getTermDouble()
```
    Deprecated. use getNumericalCoefficient() ()} instead.
    
    Get atoms array.
    
    Since:
    
    1.0.0
  - getNumericalCoefficient
```
public double getNumericalCoefficient()
```
    Get the numerical coefficient.
    
    Returns:
    
    the numerical coefficient
    
    Since:
    
    1.1.0
  - getTermAtoms
```
@Deprecated
public Atom[] getTermAtoms()
```
    Deprecated. use getAtoms() ()} instead.
    
    Since:
    
    1.0.0
  - getAtoms
```
public Atom[] getAtoms()
```
    Get the array of Atoms
    
    Returns:
    
    atoms
    
    Since:
    
    1.1.0
  - setTerm
```
@Deprecated
public void setTerm(double num,
                    Atom[] atoms)
```
    Deprecated. use Term(double, Atom[]) ()} instead.
    
    Set Term numerical coefficient and atoms array.
  - setTermDouble
```
@Deprecated
public void setTermDouble(double num)
```
    Deprecated. use setNumericalCoefficient(double) ()} instead.
    
    Set numerical coeffiecient.
  - setTerm
```
@Deprecated
public void setTerm(Atom[] atoms)
```
    Deprecated. use setAtoms(Atom[]) ()} instead.
    
    Set atoms array.
  - setNumericalCoefficient
```
public void setNumericalCoefficient(double numericalCoefficient)
```
    Set the numericalCoefficient.
    
    Parameters:
    
    numericalCoefficient -
    
    Since:
    
    1.1.0
  - setAtoms
```
public void setAtoms(Atom[] atoms)
```
    Set the array of Atoms. Note this array gets assigned, not copied.
    
    Parameters:
    
    atoms - Will become the Atoms array for this Term
    
    Since:
    
    1.0.0
  - pop
```
public Atom pop()
```
    Remove first Atom and return it.
    
    Returns:
    
    the popped Atom
    
    Since:
    
    1.1.0
  - snip
```
public Term snip()
```
    Make a new Term with the first Atom removed. Will fail with Term that has no Atoms.
    
    Returns:
    
    New term with the first Atom removed
    
    Since:
    
    1.0.0
  - paste
```
public Term paste(Atom atom)
```
    Creates a new Term with the a new Atom at the front of Term
    
    Parameters:
    
    atom -
    
    Returns:
    
    New Term with one new Atom at the beginning of the array
    
    Since:
    
    1.0.0
  - push
```
public void push(Atom atom)
```
    Inserts new Atom at the front of Term
    
    Parameters:
    
    atom -
    
    Since:
    
    1.1.0
  - append
```
public void append(Atom atom)
```
    Inserts new Atom at the end of Term
    
    Parameters:
    
    atom -
    
    Since:
    
    1.1.0
  - place
```
public Term place(Atom atom)
```
    Places a new Atom in the array of Atoms that make up the term. Atoms go in alphabetical order, then by subscript. It "myatom" is "like" (same letter & subscript) the Atoms are combined.
    example: place b^2 in the Term 3abd will result in 3ab^3d example: place c_1 in the Term 3abd will result in 3abc_1d
    
    Parameters:
    
    atom -
    
    Returns:
    
    Since:
    
    1.0.0
  - insert
```
public void insert(Atom atom)
```
    Places a new Atom in the array of Atoms that make up the term. Atoms go in alphabetical order, then by subscript. It "myatom" is "like" (same letter & subscript) the Atoms are combined.
    example: place b^2 in the Term 3abd will result in 3ab^3d example: place c_1 in the Term 3abd will result in 3abc_1d
    
    Parameters:
    
    atom -
    
    Since:
    
    1.1.0
  - simplify
```
public Term simplify()
```
    Orders Atoms and combines like Atoms in the Array of atoms. example: 3baca^2 becomes 3a^3bc
    Permanently alters the Term.
    
    Returns:
    
    Term Permanently alters the Term
    
    Since:
    
    1.0.0
  - reduce
```
public void reduce()
```
    Orders Atoms and combines like Atoms in the Array of atoms. example: 3baca^2 becomes 3a^3bc
    Permanently alters the Term.
    
    Since:
    
    1.1.0
  - times
```
public Term times(Term term)
```
    Multiply Term by another Term.
    
    Parameters:
    
    term - The Term to multiply to this one
    
    Returns:
    
    Term
    
    Since:
    
    1.0.0
  - times
```
public Term times(double scalar)
```
    Multiply Term by a scalar value.
    
    Parameters:
    
    scalar - Value to multiply this Term by
    
    Returns:
    
    the product
    
    Since:
    
    1.0.0
  - like
```
@Deprecated
public boolean like(Term term)
```
    Deprecated. Use isLike(Term) instead.
    
    Tests to see if two terms have "like" (same letter & subscript) Atoms
    
    Parameters:
    
    term - Term to compare "this" to
    
    Returns:
    
    true or false if they are "like" or not
    
    Since:
    
    1.0.0
  - isLike
```
public boolean isLike(Term term)
```
    Tests to see if two terms have "like" (same letter & subscript) Atoms
    
    Parameters:
    
    term - Term to compare "this" to
    
    Returns:
    
    true or false if they are "like" or not
    
    Since:
    
    1.1.0
  - lessThan
```
@Deprecated
public boolean lessThan(Term term)
```
    Deprecated. Use compareTo(Term) instead.
    
    Detects if the term passed in is less than this term.
    
    Parameters:
    
    term - term to compare
    
    Returns:
    
    true if this is less than the param
    
    Since:
    
    1.0.0
  - isZero
```
public boolean isZero()
```
    Checks to see of the double (and hence the Term) is zero.
    
    Returns:
    
    true if numericalCoefficient is zero.
    
    Since:
    
    1.0.0
  - isDouble
```
@Deprecated
public boolean isDouble()
```
    Deprecated. use isConstantTerm() instead.
    
    Non-descriptive method name.
    
    Since:
    
    1.0.0
  - isConstantTerm
```
public boolean isConstantTerm()
```
    Checks if this is a constant term, i.e. no variables.
    
    Returns:
    
    true if a constant term
    
    Since:
    
    1.1.0
  - identicalTo
```
@Deprecated
public boolean identicalTo(Term term)
```
    Deprecated. use equals(Term) instead.
    
    Since:
    
    1.0.0
  - print
```
@Deprecated
public void print()
```
    Deprecated. use toString() instead.
    
    Since:
    
    1.0.0
  - equals
```
public boolean equals(Term term)
```
    Check equality between two Terms.
    
    Parameters:
    
    term - Term to check
    
    Returns:
    
    boolean True if they are equal
    
    Since:
    
    1.1.0
  - toString
```
public java.lang.String toString()
```
    Composes a printable string of this term.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a printable string
    
    Since:
    
    1.1.0
  - compareTo
```
public int compareTo(Term t)
```
    Used for Arrays.sort. Sorts the atoms, then compares alphanumerically. Ignores the numerical coefficient.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<Term>
    
    Parameters:
    
    t - Term to compare to
    
    Returns:
    
    0 for equal, -1 for less than, 1 for greater than.
    
    Since:
    
    1.1.0

Class Term

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Term

Term

Term

Term

Term

Method Detail

getTermDouble

getNumericalCoefficient

getTermAtoms

getAtoms

setTerm

setTermDouble

setTerm

setNumericalCoefficient

setAtoms

pop

snip

paste

push

append

place

insert

simplify

reduce

times

times

like

isLike

lessThan

isZero

isDouble

isConstantTerm

identicalTo

print

equals

toString

compareTo