HMArrayList

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<IExpr>
  - - org.matheclipse.core.expression.AbstractAST
    - - org.matheclipse.core.expression.HMArrayList

All Implemented Interfaces:

edu.jas.structure.AbelianGroupElem<IExpr>, edu.jas.structure.Element<IExpr>, edu.jas.structure.GcdRingElem<IExpr>, edu.jas.structure.MonoidElem<IExpr>, edu.jas.structure.RingElem<IExpr>, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<IExpr>, java.lang.Iterable<IExpr>, java.util.Collection<IExpr>, java.util.List<IExpr>, java.util.RandomAccess, org.apache.commons.math4.FieldElement<IExpr>, IAST, IExpr

Direct Known Subclasses:

AST
```
public abstract class HMArrayList
extends AbstractAST
implements java.util.List<IExpr>, java.lang.Cloneable, java.io.Serializable, java.util.RandomAccess
```
HMArrayList is an implementation of List, backed by an array. All optional operations adding, removing, and replacing are supported. The elements can be any objects. Copied and modified from the Apache Harmony project.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class org.matheclipse.core.expression.AbstractAST
  AbstractAST.ASTIterator
- Nested classes/interfaces inherited from interface org.matheclipse.core.interfaces.IAST
  IAST.PROPERTY

Field Summary

Fields
Modifier and Type Field and Description

protected IExpr[] array

protected int lastIndex
- Fields inherited from class org.matheclipse.core.expression.AbstractAST
  fEvalFlags, hashValue
- Fields inherited from class java.util.AbstractList
  modCount
- Fields inherited from interface org.matheclipse.core.interfaces.IAST
  CONTAINS_DEFAULT_PATTERN, CONTAINS_NO_DEFAULT_PATTERN_MASK, CONTAINS_NO_PATTERN, CONTAINS_PATTERN, CONTAINS_PATTERN_EXPR, CONTAINS_PATTERN_SEQUENCE, IS_ALL_EXPANDED, IS_DECOMPOSED_PARTIAL_FRACTION, IS_EXPANDED, IS_FLAT_ORDERLESS_EVALED, IS_FLATTENED, IS_FLATTENED_OR_SORTED_MASK, IS_LISTABLE_THREADED, IS_MATRIX, IS_MATRIX_OR_VECTOR, IS_SORTED, IS_VECTOR, NO_FLAG
- Fields inherited from interface org.matheclipse.core.interfaces.IExpr
  ASTID, BLANKID, COMPLEXID, DOUBLECOMPLEXID, DOUBLEID, FRACTIONID, INTEGERID, METHODSYMBOLID, PATTERNID, STRINGID, SYMBOLID

Fields
Modifier and Type	Field and Description
`protected IExpr[]`	`array`
`protected int`	`lastIndex`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`HMArrayList()` Constructs a new instance of `ArrayList` with ten capacity.
	`HMArrayList(java.util.Collection<? extends E> collection)` Constructs a new instance of `ArrayList` containing the elements of the specified collection.
`protected`	`HMArrayList(IExpr[] array)`
	`HMArrayList(IExpr ex, IExpr... es)`
	`HMArrayList(int capacity)` Constructs a new instance of `ArrayList` with the specified capacity.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`add(IExpr object)` Adds the specified object at the end of this `ArrayList`.
`void`	`add(int location, IExpr object)` Inserts the specified object into this `ArrayList` at the specified location.
`boolean`	`addAll(java.util.Collection<? extends IExpr> collection)` Adds the objects in the specified collection to this `ArrayList`.
`boolean`	`addAll(int location, java.util.Collection<? extends IExpr> collection)` Inserts the objects in the specified collection at the specified location in this List.
`IExpr`	`arg1()` Get the first argument (i.e. the second element of the underlying list structure) of the `AST` function (i.e. get(1) ).
`IExpr`	`arg2()` Get the second argument (i.e. the third element of the underlying list structure) of the `AST` function (i.e. get(2) ).
`IExpr`	`arg3()` Get the third argument (i.e. the fourth element of the underlying list structure) of the `AST` function (i.e. get(3) ).
`IExpr`	`arg4()` Get the fourth argument (i.e. the fifth element of the underlying list structure) of the `AST` function (i.e. get(4) ).
`IExpr`	`arg5()` Get the fifth argument (i.e. the sixth element of the underlying list structure) of the `AST` function (i.e. get(5) ).
`java.util.Set<IExpr>`	`asSet()` Collect all arguments of this AST in a new set.
`void`	`clear()` Removes all elements from this `ArrayList`, leaving it empty.
`IAST`	`clone()` Returns a new `HMArrayList` with the same elements, the same size and the same capacity as this `HMArrayList`.
`void`	`ensureCapacity(int minimumCapacity)` Ensures that after this operation the `ArrayList` can hold the specified number of elements without further growing.
`boolean`	`equals(java.lang.Object obj)` Test if this is equal to b.
`IExpr`	`get(int location)`
`IExpr`	`head()` If this object is an instance of `IAST` get the first element (offset 0) of the `IAST` list (i.e. get(0) ).
`protected void`	`init(IExpr[] array)`
`IExpr`	`remove(int location)` Removes the object at the specified location from this list.
`boolean`	`remove(java.lang.Object object)`
`protected void`	`removeRange(int start, int end)` Removes the objects in the specified range from the start to the end, but not including the end index.
`IExpr`	`set(int location, IExpr object)` Replaces the element at the specified location in this `ArrayList` with the specified object.
`int`	`size()` Returns the number of elements in this `ArrayList`.
`java.lang.Object[]`	`toArray()` Returns a new array containing all elements contained in this `ArrayList`.
`<T> T[]`	`toArray(T[] contents)` Returns an array containing all elements contained in this `ArrayList`.
`void`	`trimToSize()` Sets the capacity of this `ArrayList` to be the same as the current size.

Methods inherited from class org.matheclipse.core.expression.AbstractAST
$div, $minus, $plus, $times, $up, abs, accept, accept, accept, accept, addAtClone, addEvalFlags, and, appendClone, apply, apply, apply, apply, apply, args, asType, clearHashCache, compareTo, contains, copy, copyFrom, copyHead, copyUntil, copyUntil, dec, divide, egcd, equalsAt, equalsFromPosition, evalComplex, evalDouble, evalNumber, evalSignedNumber, evaluate, factory, filter, filter, filter, filter, filter, filter, filter, findFirstEquals, forEach, fullFormString, gcd, getAST, getAt, getEvalFlags, getHashCache, getInt, getList, getNumber, getOneIdentity, getPart, getPart, hashCode, hierarchy, inc, indexOf, internalFormString, internalJavaString, internalScalaString, inverse, isAllExpanded, isAnd, isArcCos, isArcCosh, isArcSin, isArcSinh, isArcTan, isArcTanh, isAST, isAST, isAST, isAST, isAST, isAST, isAST, isASTSizeGE, isAtom, isComplex, isComplexInfinity, isComplexNumeric, isCondition, isCos, isCosh, isDerivative, isDirectedInfinity, isEmpty, isEvalFlagOff, isEvalFlagOn, isExpanded, isFlatAST, isFraction, isFree, isFree, isFree, isFreeAST, isFreeAST, isFreeAt, isFreeOfPatterns, isFunction, isGEOrdered, isGTOrdered, isInfinity, isInteger, isIntegerResult, isList, isListOfLists, isLog, isMatrix, isMember, isModule, isNegative, isNegativeInfinity, isNegativeResult, isNonNegativeResult, isNot, isNumber, isNumeric, isNumericFunction, isNumericMode, isOr, isOrderlessAST, isPatternExpr, isPlus, isPlusTimesPower, isPolynomial, isPolynomial, isPolynomialOfMaxDegree, isPolynomialOfMaxDegree, isPositive, isPositiveResult, isPower, isRationalResult, isRealResult, isRuleAST, isSame, isSame, isSameHead, isSameHead, isSameHead, isSameHeadSizeGE, isSequence, isSignedNumber, isSin, isSinh, isSlot, isSlotSequence, isSpan, isTan, isTanh, isTimes, isUnit, isValue, isVector, iterator, iterator0, last, lastIndexOf, leafCount, leaves, map, map, map, map, mapAt, mapAt, minus, mod, multiply, negate, negative, opposite, optional, or, patternHashCode, plus, power, power, prependClone, range, range, range, remainder, removeAtClone, replaceAll, replaceAll, replacePart, replaceRepeated, replaceRepeated, replaceSlots, setAtClone, setEvalFlags, signum, subtract, sum, times, timesDistributed, topHead, toScript, toScriptFactory, toString, variables2Slots

Methods inherited from class java.util.AbstractList
listIterator, listIterator, subList

Methods inherited from class java.util.AbstractCollection
containsAll, removeAll, retainAll

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

Methods inherited from interface java.util.List
contains, containsAll, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, removeAll, replaceAll, retainAll, sort, spliterator, subList

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

Methods inherited from interface org.matheclipse.core.interfaces.IAST
addAll, addAll, addOneIdentity, setAtCopy

Methods inherited from interface org.matheclipse.core.interfaces.IExpr
evaluateHead, getField, ifPresent, isBlank, isConstant, isE, isFalse, isIndeterminate, isLEOrdered, isLTOrdered, isMember, isMinusOne, isNumEqualInteger, isNumEqualRational, isNumIntValue, isOne, isONE, isPattern, isPatternDefault, isPatternSequence, isPi, isPresent, isRational, isRationalValue, isSymbol, isTrue, isVariable, isZero, isZERO, multiply, ofNullable, orElse, orElseGet, orElseThrow, reciprocal

- Field Detail
  - array
```
protected transient IExpr[] array
```
  - lastIndex
```
protected transient int lastIndex
```
- Constructor Detail
  - HMArrayList
```
public HMArrayList()
```
    Constructs a new instance of ArrayList with ten capacity.
  - HMArrayList
```
public HMArrayList(java.util.Collection<? extends E> collection)
```
    Constructs a new instance of ArrayList containing the elements of the specified collection. The initial size of the ArrayList will be 10% higher than the size of the specified collection.
    
    Parameters:
    
    collection - the collection of elements to add.
  - HMArrayList
```
public HMArrayList(IExpr ex,
                   IExpr... es)
```
  - HMArrayList
```
protected HMArrayList(IExpr[] array)
```
  - HMArrayList
```
public HMArrayList(int capacity)
```
    Constructs a new instance of ArrayList with the specified capacity.
    
    Parameters:
    
    capacity - the initial capacity of this ArrayList.
- Method Detail
  - arg1
```
public final IExpr arg1()
```
    Get the first argument (i.e. the second element of the underlying list structure) of the AST function (i.e. get(1) ).
    Example: for the AST representing the expression Sin(x), arg1() returns x.
    
    Specified by:
    
    arg1 in interface IAST
    
    Returns:
    
    the first argument of the function represented by this AST.
    
    See Also:
    
    IExpr.head()
  - arg2
```
public final IExpr arg2()
```
    Get the second argument (i.e. the third element of the underlying list structure) of the AST function (i.e. get(2) ).
    Example: for the AST representing the expression x^y (i.e. Power(x, y)), arg2() returns y.
    
    Specified by:
    
    arg2 in interface IAST
    
    Returns:
    
    the second argument of the function represented by this AST.
    
    See Also:
    
    IExpr.head()
  - arg3
```
public final IExpr arg3()
```
    Get the third argument (i.e. the fourth element of the underlying list structure) of the AST function (i.e. get(3) ).
    Example: for the AST representing the expression f(a, b, c), arg3() returns c.
    
    Specified by:
    
    arg3 in interface IAST
    
    Returns:
    
    the third argument of the function represented by this AST.
    
    See Also:
    
    IExpr.head()
  - arg4
```
public final IExpr arg4()
```
    Get the fourth argument (i.e. the fifth element of the underlying list structure) of the AST function (i.e. get(4) ).
    Example: for the AST representing the expression f(a, b ,c, d), arg4() returns d.
    
    Specified by:
    
    arg4 in interface IAST
    
    Returns:
    
    the fourth argument of the function represented by this AST.
    
    See Also:
    
    IExpr.head()
  - arg5
```
public final IExpr arg5()
```
    Get the fifth argument (i.e. the sixth element of the underlying list structure) of the AST function (i.e. get(5) ).
    Example: for the AST representing the expression f(a, b ,c, d, e), arg5() returns e .
    
    Specified by:
    
    arg5 in interface IAST
    
    Returns:
    
    the fifth argument of the function represented by this AST.
    
    See Also:
    
    IExpr.head()
  - asSet
```
public java.util.Set<IExpr> asSet()
```
    Description copied from interface: IAST
    
    Collect all arguments of this AST in a new set.
    
    Specified by:
    
    asSet in interface IAST
    
    Returns:
  - add
```
public boolean add(IExpr object)
```
    Adds the specified object at the end of this ArrayList.
    
    Specified by:
    
    add in interface java.util.Collection<IExpr>
    
    Specified by:
    
    add in interface java.util.List<IExpr>
    
    Overrides:
    
    add in class java.util.AbstractList<IExpr>
    
    Parameters:
    
    object - the object to add.
    
    Returns:
    
    always true
  - add
```
public void add(int location,
                IExpr object)
```
    Inserts the specified object into this ArrayList at the specified location. The object is inserted before any previous element at the specified location. If the location is equal to the size of this ArrayList, the object is added at the end.
    
    Specified by:
    
    add in interface java.util.List<IExpr>
    
    Overrides:
    
    add in class java.util.AbstractList<IExpr>
    
    Parameters:
    
    location - the index at which to insert the object.
    
    object - the object to add.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - when location < 0 || > size()
  - addAll
```
public boolean addAll(java.util.Collection<? extends IExpr> collection)
```
    Adds the objects in the specified collection to this ArrayList.
    
    Specified by:
    
    addAll in interface java.util.Collection<IExpr>
    
    Specified by:
    
    addAll in interface java.util.List<IExpr>
    
    Overrides:
    
    addAll in class java.util.AbstractCollection<IExpr>
    
    Parameters:
    
    collection - the collection of objects.
    
    Returns:
    
    true if this ArrayList is modified, false otherwise.
  - addAll
```
public boolean addAll(int location,
                      java.util.Collection<? extends IExpr> collection)
```
    Inserts the objects in the specified collection at the specified location in this List. The objects are added in the order they are returned from the collection's iterator.
    
    Specified by:
    
    addAll in interface java.util.List<IExpr>
    
    Overrides:
    
    addAll in class java.util.AbstractList<IExpr>
    
    Parameters:
    
    location - the index at which to insert.
    
    collection - the collection of objects.
    
    Returns:
    
    true if this ArrayList is modified, false otherwise.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - when location < 0 || > size()
  - clear
```
public void clear()
```
    Removes all elements from this ArrayList, leaving it empty.
    
    Specified by:
    
    clear in interface java.util.Collection<IExpr>
    
    Specified by:
    
    clear in interface java.util.List<IExpr>
    
    Overrides:
    
    clear in class java.util.AbstractList<IExpr>
    
    See Also:
    
    AbstractAST.isEmpty(), size()
  - clone
```
public IAST clone()
```
    Returns a new HMArrayList with the same elements, the same size and the same capacity as this HMArrayList.
    
    Specified by:
    
    clone in interface IAST
    
    Overrides:
    
    clone in class AbstractAST
    
    Returns:
    
    a shallow copy of this ArrayList
    
    See Also:
    
    Cloneable
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Description copied from interface: edu.jas.structure.Element
    
    Test if this is equal to b.
    
    Specified by:
    
    equals in interface edu.jas.structure.Element<IExpr>
    
    Specified by:
    
    equals in interface java.util.Collection<IExpr>
    
    Specified by:
    
    equals in interface java.util.List<IExpr>
    
    Overrides:
    
    equals in class AbstractAST
    
    Returns:
    
    true if this is equal to b, else false.
  - ensureCapacity
```
public void ensureCapacity(int minimumCapacity)
```
    Ensures that after this operation the ArrayList can hold the specified number of elements without further growing.
    
    Parameters:
    
    minimumCapacity - the minimum capacity asked for.
  - get
```
public IExpr get(int location)
```
    Specified by:
    
    get in interface java.util.List<IExpr>
    
    Overrides:
    
    get in class AbstractAST
  - head
```
public final IExpr head()
```
    Description copied from interface: IExpr
    
    If this object is an instance of IAST get the first element (offset 0) of the IAST list (i.e. get(0) ).
    
    Specified by:
    
    head in interface IExpr
    
    Returns:
    
    the head of the expression, which must not be null.
  - init
```
protected final void init(IExpr[] array)
```
  - remove
```
public IExpr remove(int location)
```
    Removes the object at the specified location from this list.
    
    Specified by:
    
    remove in interface java.util.List<IExpr>
    
    Overrides:
    
    remove in class java.util.AbstractList<IExpr>
    
    Parameters:
    
    location - the index of the object to remove.
    
    Returns:
    
    the removed object.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - when location < 0 || >= size()
  - remove
```
public boolean remove(java.lang.Object object)
```
    Specified by:
    
    remove in interface java.util.Collection<IExpr>
    
    Specified by:
    
    remove in interface java.util.List<IExpr>
    
    Overrides:
    
    remove in class java.util.AbstractCollection<IExpr>
  - removeRange
```
protected void removeRange(int start,
                           int end)
```
    Removes the objects in the specified range from the start to the end, but not including the end index.
    
    Overrides:
    
    removeRange in class java.util.AbstractList<IExpr>
    
    Parameters:
    
    start - the index at which to start removing.
    
    end - the index one after the end of the range to remove.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - when start < 0, start > end or end > size()
  - set
```
public IExpr set(int location,
                 IExpr object)
```
    Replaces the element at the specified location in this ArrayList with the specified object.
    
    Specified by:
    
    set in interface java.util.List<IExpr>
    
    Overrides:
    
    set in class java.util.AbstractList<IExpr>
    
    Parameters:
    
    location - the index at which to put the specified object.
    
    object - the object to add.
    
    Returns:
    
    the previous element at the index.
    
    Throws:
    
    java.lang.IndexOutOfBoundsException - when location < 0 || >= size()
  - size
```
public int size()
```
    Returns the number of elements in this ArrayList.
    
    Specified by:
    
    size in interface java.util.Collection<IExpr>
    
    Specified by:
    
    size in interface java.util.List<IExpr>
    
    Overrides:
    
    size in class AbstractAST
    
    Returns:
    
    the number of elements in this ArrayList.
  - toArray
```
public java.lang.Object[] toArray()
```
    Returns a new array containing all elements contained in this ArrayList.
    
    Specified by:
    
    toArray in interface java.util.Collection<IExpr>
    
    Specified by:
    
    toArray in interface java.util.List<IExpr>
    
    Overrides:
    
    toArray in class java.util.AbstractCollection<IExpr>
    
    Returns:
    
    an array of the elements from this ArrayList
  - toArray
```
public <T> T[] toArray(T[] contents)
```
    Returns an array containing all elements contained in this ArrayList. If the specified array is large enough to hold the elements, the specified array is used, otherwise an array of the same type is created. If the specified array is used and is larger than this ArrayList, the array element following the collection elements is set to null.
    
    Specified by:
    
    toArray in interface java.util.Collection<IExpr>
    
    Specified by:
    
    toArray in interface java.util.List<IExpr>
    
    Overrides:
    
    toArray in class java.util.AbstractCollection<IExpr>
    
    Parameters:
    
    contents - the array.
    
    Returns:
    
    an array of the elements from this ArrayList.
    
    Throws:
    
    java.lang.ArrayStoreException - when the type of an element in this ArrayList cannot be stored in the type of the specified array.
  - trimToSize
```
public void trimToSize()
```
    Sets the capacity of this ArrayList to be the same as the current size.
    
    See Also:
    
    size()

Class HMArrayList

Nested Class Summary

Nested classes/interfaces inherited from class org.matheclipse.core.expression.AbstractAST

Nested classes/interfaces inherited from interface org.matheclipse.core.interfaces.IAST

Field Summary

Fields inherited from class org.matheclipse.core.expression.AbstractAST

Fields inherited from class java.util.AbstractList

Fields inherited from interface org.matheclipse.core.interfaces.IAST

Fields inherited from interface org.matheclipse.core.interfaces.IExpr

Constructor Summary

Method Summary

Methods inherited from class org.matheclipse.core.expression.AbstractAST

Methods inherited from class java.util.AbstractList

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Methods inherited from interface org.matheclipse.core.interfaces.IAST

Methods inherited from interface org.matheclipse.core.interfaces.IExpr

Field Detail

array

lastIndex

Constructor Detail

HMArrayList

HMArrayList

HMArrayList

HMArrayList

HMArrayList

Method Detail

arg1

arg2

arg3

arg4

arg5

asSet

add

add

addAll

addAll

clear

clone

equals

ensureCapacity

get

head

init

remove

remove

removeRange

set

size

toArray

toArray

trimToSize