Package org.dalton.polyfun

Class Atom

java.lang.Object

org.dalton.polyfun.Atom

All Implemented Interfaces:

java.lang.Comparable<Atom>

public class Atom
extends java.lang.Object
implements java.lang.Comparable<Atom>

An Atom is a letter, a subscript, and a power which represents the basic part of the coefficient of a polynomial.

For example: In the polynomial in x:

P(x) = 2(a_1)^3(b)x^4 - (a_2)(b_4)x^2 + 7ab

2(a_1)^3(b) is a coefficient, with two atoms: (a_1)^3 and (b)

Constructor Summary

Constructors

Constructor	Description
Atom()	Default constructor.
Atom(char letter)	Create an atom with just a letter.
Atom(char letter, int subscript, int power)	Construct a letter, subscript, power.

Method Summary

Modifier and Type	Method	Description
int	compareTo(Atom a)
boolean	equals(Atom atom)	Checks equality between Atoms.
char	getLetter()	Get letter
int	getPower()	Get power
int	getSubscript()	Get subscript
boolean	identicalTo(Atom atom)	Deprecated. Use equals(Atom) instead.
boolean	isLessThan(Atom atom)	Compares two atoms by letter and subscript only.
boolean	isLessThanOrEquals(Atom atom)	Defines a way of comparing two atoms.
boolean	isLike(Atom atom)	Test to see if Atoms are "like" (same letter, subscript)
boolean	lessThan(Atom atom)	Deprecated. Use isLessThan(Atom) instead
boolean	lessThanOrEqual(Atom atom)	Deprecated. Use isLessThanOrEquals(Atom) instead.
boolean	like(Atom atom)	Deprecated. Use isLike(Atom) instead.
void	print()	Deprecated. Use toString() instead
void	setAtom(char letter, int subscript, int power)	Create an Atom by entering a letter, a subscript, and a power
void	setLetter(char letter)	Set letter.
void	setPower(int power)	Set power.
void	setSubscript(int subscript)	Set subscript.
Atom	timesLikeAtom(Atom atom)	Multiply two atoms which have the same letter and subscript.
java.lang.String	toString()	Returns a printable string of the Atom.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Atom

public Atom()

Default constructor.

Since:

1.0.0

Atom

public Atom(char letter,
            int subscript,
            int power)

Construct a letter, subscript, power. E.g. 'a', 1, 2 will make the atom a_1^2.

Parameters:

letter -

subscript -

power -

Since:

1.0.0

Atom

public Atom(char letter)

Create an atom with just a letter.

Parameters:

letter - The new letter.

Since:

1.0.0

Method Detail

getLetter

public char getLetter()

Get letter

Returns:

This atom's letter variable

Since:

1.0.0

getSubscript

public int getSubscript()

Get subscript

Returns:

This atom's subscript

Since:

1.0.0

getPower

public int getPower()

Get power

Returns:

This atom's exponent

Since:

1.0.0

setLetter

public void setLetter(char letter)

Set letter.

Parameters:

letter -

Since:

1.0.0

setSubscript

public void setSubscript(int subscript)

Set subscript.

Parameters:

subscript -

Since:

1.0.0

setPower

public void setPower(int power)

Set power.

Parameters:

power -

Since:

1.0.0

setAtom

public void setAtom(char letter,
                    int subscript,
                    int power)

Create an Atom by entering a letter, a subscript, and a power

Parameters:

letter - The letter

subscript - The subscript

power - The power (i.e. exponent)

Since:

1.0.0

timesLikeAtom

public Atom timesLikeAtom(Atom atom)

Multiply two atoms which have the same letter and subscript. For example: (a_1)^3 * (a_1)^4 = (a_1)^7

The original atom remains unchanged

Parameters:

atom - the like atom to multiply by

Returns:

the product

Since:

1.0.0

like

@Deprecated
public boolean like(Atom atom)

Deprecated. Use isLike(Atom) instead.

Test to see if Atoms are "like" (same letter, subscript)

Parameters:

atom - Atom to compare this to.

Returns:

true if the two Atoms have same letter and subscript.

Since:

1.0.0

isLike

public boolean isLike(Atom atom)

Test to see if Atoms are "like" (same letter, subscript)

Parameters:

atom - Atom to compare this to.

Returns:

true if the two Atoms have same letter and subscript.

Since:

1.1.0

lessThanOrEqual

@Deprecated
public boolean lessThanOrEqual(Atom atom)

Deprecated. Use isLessThanOrEquals(Atom) instead.

Defines a way of comparing two atoms. If letters are in alphabetical order it's true. If letters are the same, but subscripts are in increasing order it's true. If letters are the same, and subscripts are the same, and powers are equal or in increasing order it's true. Otherwise it's false.

Parameters:

atom - Atom to compare this to.

Returns:

true if this is less than or equal to the atom passed in.

Since:

1.0.0

isLessThanOrEquals

public boolean isLessThanOrEquals(Atom atom)

Defines a way of comparing two atoms. If letters are in alphabetical order it's true. If letters are the same, but subscripts are in increasing order it's true. If letters are the same, and subscripts are the same, and powers are equal or in increasing order it's true. Otherwise it's false.

Parameters:

atom - Atom to compare this to.

Returns:

true if this is less than or equal to the atom passed in.

Since:

1.1.0

lessThan

@Deprecated
public boolean lessThan(Atom atom)

Deprecated. Use isLessThan(Atom) instead

Compares two atoms by letter and subscript only. If the letters are in alphabetical order it's true. If the letters are the same, and the subscripts are in increasing order it's true. Otherwise it's false.

Parameters:

atom - Atom to compare this to.

Returns:

true if this is less than the atom passed in

Since:

1.0.0

isLessThan

public boolean isLessThan(Atom atom)

Compares two atoms by letter and subscript only. If the letters are in alphabetical order it's true. If the letters are the same, and the subscripts are in increasing order it's true. Otherwise it's false.

Parameters:

atom - Atom to compare this to.

Returns:

true if this is less than the atom passed in

Since:

1.1.0

identicalTo

@Deprecated
public boolean identicalTo(Atom atom)

Deprecated. Use equals(Atom) instead.

Test to see if Atoms are exactly identical (same letter, subscript, and power)

Parameters:

atom -

Returns:

true if same

Since:

1.0.0

print

@Deprecated
public void print()

Deprecated. Use toString() instead

Prints the Atom.

Since:

1.0.0

equals

public boolean equals(Atom atom)

Checks equality between Atoms.

Parameters:

atom - - The org.dalton.polyfun.Atom to compare to this one.

Returns:

boolean

Since:

1.1.0

toString

public java.lang.String toString()

Returns a printable string of the Atom.

Overrides:

toString in class java.lang.Object

Returns:

A string.

Since:

1.1.0

compareTo

public int compareTo(Atom a)

Specified by:

compareTo in interface java.lang.Comparable<Atom>

Parameters:

a -

Returns:

-1 for less than, 0 for equal, 1 for greater than

Since:

1.1.0