Coef

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

```
public class Coef
extends java.lang.Object
```
An array of Terms. The Terms are understood to be added. For example: In the polynomial in x:
P(x) = [2(a_1)^3(b) + 3b^2]x^4 - (a_2)(b_4)x^2 + 7ab + b_2
2(a_1)^3(b)+3b^2 is a Coef, as is -(a_2)(b_4) and 7ab + b_2. The first and third have length 2 (two Terms) the middle has length 1 (one term)

Constructor Summary

Constructors
Constructor	Description
`Coef()`	Default constructor.
`Coef(char letter)`	Construct a Coef with just one letter (no numerical coefficient or exponent).
`Coef(double constant)`	Construct a Coef with just a constant.
`Coef(Atom atom)`	Construct a Coef with just 1 Atom.
`Coef(Term term)`	Construct a Coef with just 1 term.
`Coef(Term[] terms)`	Constructor that takes an array of Terms and copies the values into the terms array.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Term[]`	`getTerms()`	Get terms array.
`void`	`insert(Term term)`	Inserts given Term in a convenient order or combines it with a like another like Term
`boolean`	`isConstantCoef()`	True if Coef consists only of a double, false otherwise.
`boolean`	`isDouble()`	Deprecated. use `isConstantCoef()` instead.
`boolean`	`isZero()`	If the Coef is zero, it returns true.
`Coef`	`paste(Term term)`	Creates new Coef array with the new Term at the front of the array of Terms.
`Coef`	`place(Term term)`	Creates a new Coef with the Term inserted in a convenient order or combines it with a like another like Term
`Coef`	`plus(Coef coef)`	Add Coefs by combining like Terms and adding unlike Terms
`Term`	`pop()`	Remove first Term.
`void`	`print()`	Deprecated. Use `toString()` instead.
`void`	`push(Term term)`	Inserts new Term at the front of the array of Terms.
`void`	`reduce()`	Combines like terms and writes them in order.
`void`	`setTerms(Term term)`	Set terms array with this term as the only element
`void`	`setTerms(Term[] terms)`	Set terms array.
`Coef`	`simplify()`	Combines like terms and writes them in order.
`Coef`	`snip()`	Create new Ceof array with the first Term removed.
`Coef`	`times(double scalar)`	Multiplies each Term in the Coef by a scalar (double)
`Coef`	`times(Coef coef)`	Multiply a Coefficient by another Coefficient.
`java.lang.String`	`toString()`	Compose a printable string of the Coef.

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

- Constructor Detail
  - Coef
```
public Coef()
```
    Default constructor.
    
    Since:
    
    1.0.0
  - Coef
```
public Coef(Term[] terms)
```
    Constructor that takes an array of Terms and copies the values into the terms array.
    
    Parameters:
    
    terms - the Term array to copy
    
    Since:
    
    1.0.0
  - Coef
```
public Coef(Term term)
```
    Construct a Coef with just 1 term. The Term is inserted into an array of length 1.
    
    Parameters:
    
    term - A single Term that becomes the Coef.
    
    Since:
    
    1.0.0
  - Coef
```
public Coef(Atom atom)
```
    Construct a Coef with just 1 Atom. The Atom is made into a Term and the Term is put into an array.
    
    Parameters:
    
    atom - Atom object used to initialize a term which will be the only element in the terms array.
    
    Since:
    
    1.0.0
  - Coef
```
public Coef(double constant)
```
    Construct a Coef with just a constant. The constant is converted into a Term and the Term is put into the array.
    
    Parameters:
    
    constant -
    
    Since:
    
    1.0.0
  - Coef
```
public Coef(char letter)
```
    Construct a Coef with just one letter (no numerical coefficient or exponent).
    
    Parameters:
    
    letter - Used to create the term, which is the only element in the Term array.
    
    Since:
    
    1.0.0
- Method Detail
  - getTerms
```
public Term[] getTerms()
```
    Get terms array.
    
    Returns:
    
    terms array
    
    Since:
    
    1.0.0
  - setTerms
```
public void setTerms(Term[] terms)
```
    Set terms array. The array passed in is copied to the terms attribute.
    
    Parameters:
    
    terms -
    
    Since:
    
    1.0.0
  - setTerms
```
public void setTerms(Term term)
```
    Set terms array with this term as the only element
    
    Parameters:
    
    term - term that will make up the terms array
    
    Since:
    
    1.0.0
  - snip
```
public Coef snip()
```
    Create new Ceof array with the first Term removed. Meant for array > 1 only.
    
    Returns:
    
    a new Coef with one less Term.
    
    Since:
    
    1.0.0
  - pop
```
public Term pop()
```
    Remove first Term.
    
    Returns:
    
    The popped Term or null
    
    Since:
    
    1.1.0
  - paste
```
public Coef paste(Term term)
```
    Creates new Coef array with the new Term at the front of the array of Terms.
    
    Parameters:
    
    term - Term to place in front.
    
    Returns:
    
    A new Coef with another Term (original Coef is not changed)
    
    Since:
    
    1.0.0
  - push
```
public void push(Term term)
```
    Inserts new Term at the front of the array of Terms.
    
    Parameters:
    
    term - Term to place in front.
    
    Since:
    
    1.1.0
  - place
```
public Coef place(Term term)
```
    Creates a new Coef with the Term inserted in a convenient order or combines it with a like another like Term
    
    Parameters:
    
    term -
    
    Returns:
    
    A new Coef with another Term (original Coef is not changed)
    
    Since:
    
    1.0.0
  - insert
```
public void insert(Term term)
```
    Inserts given Term in a convenient order or combines it with a like another like Term
    
    Parameters:
    
    term -
    
    Since:
    
    1.1.0
  - simplify
```
public Coef simplify()
```
    Combines like terms and writes them in order.
    
    Returns:
    
    this The original Coef is permanently altered.
    
    Since:
    
    1.0.0
  - reduce
```
public void reduce()
```
    Combines like terms and writes them in order.
    
    Since:
    
    1.1.0
  - times
```
public Coef times(Coef coef)
```
    Multiply a Coefficient by another Coefficient.
    
    Parameters:
    
    coef - The Coef object to multiply to this one.
    
    Returns:
    
    the product
    
    Since:
    
    1.0.0
  - times
```
public Coef times(double scalar)
```
    Multiplies each Term in the Coef by a scalar (double)
    
    Parameters:
    
    scalar - The double to multiply it by
    
    Returns:
    
    Coef that's been multiplied by a scalar
    
    Since:
    
    1.0.0
  - plus
```
public Coef plus(Coef coef)
```
    Add Coefs by combining like Terms and adding unlike Terms
    
    Parameters:
    
    coef - Coef to be added to the first Coef
    
    Returns:
    
    The sum of this and that
    
    Since:
    
    1.0.0
  - isZero
```
public boolean isZero()
```
    If the Coef is zero, it returns true.
    
    Returns:
    
    true if the Coeff is 0
    
    Since:
    
    1.0.0
  - isDouble
```
@Deprecated
public boolean isDouble()
```
    Deprecated. use isConstantCoef() instead.
    
    True if Coef consists only of a double, false otherwise
    
    Returns:
    
    True if Coef consists only of a double, false otherwise
    
    Since:
    
    1.0.0
  - isConstantCoef
```
public boolean isConstantCoef()
```
    True if Coef consists only of a double, false otherwise.
    
    Returns:
    
    True if Coef consists only of a double, false otherwise
    
    Since:
    
    1.1.0
  - print
```
@Deprecated
public void print()
```
    Deprecated. Use toString() instead.
    
    Since:
    
    1.0.0
  - toString
```
public java.lang.String toString()
```
    Compose a printable string of the Coef.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    a printable string
    
    Since:
    
    1.1.0

Class Coef

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Coef

Coef

Coef

Coef

Coef

Coef

Method Detail

getTerms

setTerms

setTerms

snip

pop

paste

push

place

insert

simplify

reduce

times

times

plus

isZero

isDouble

isConstantCoef

print

toString