repicea.simulation.stemtaper

Class StemTaperSegmentList

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<StemTaperSegment>

repicea.simulation.stemtaper.StemTaperSegmentList

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<StemTaperSegment>, java.util.Collection<StemTaperSegment>, java.util.List<StemTaperSegment>, java.util.RandomAccess

public class StemTaperSegmentList
extends java.util.ArrayList<StemTaperSegment>

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
StemTaperSegmentList()

Method Summary

Modifier and Type	Method and Description
static StemTaperSegmentList	createStemTaperSegmentList(java.util.List<java.lang.Double> heights, boolean optimize) This static methods provides a list of StemTaperSegment instances embedded in a StemTaperSegmentList.
protected java.util.List<java.lang.Double>	getHeights() This method returns a List of Double instance that corresponds to the heights (m) across all segments.
java.util.List<java.lang.Double>	getHeightsWithoutReplicates() This method returns a List of Double instance that corresponds to the heights (m) across all segments without replicates.
protected java.util.List<java.lang.Double>	getRescalingFactorsAcrossSegments() This method returns a List of Double instances that correspond to the rescaling factors across the segments.
protected java.util.List<java.lang.Double>	getWeightsAcrossSegments() This method returns a List of Double instances that correspond to the weights across the segments.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

StemTaperSegmentList

public StemTaperSegmentList()

Method Detail

getHeights

protected java.util.List<java.lang.Double> getHeights()

This method returns a List of Double instance that corresponds to the heights (m) across all segments.

Returns:

a List of Double instances

getHeightsWithoutReplicates

public java.util.List<java.lang.Double> getHeightsWithoutReplicates()

This method returns a List of Double instance that corresponds to the heights (m) across all segments without replicates. This method is essential to avoid having the matrices singular.

Returns:

a List of Double instances

getWeightsAcrossSegments

protected java.util.List<java.lang.Double> getWeightsAcrossSegments()

This method returns a List of Double instances that correspond to the weights across the segments.

Returns:

a List of Double

getRescalingFactorsAcrossSegments

protected java.util.List<java.lang.Double> getRescalingFactorsAcrossSegments()

This method returns a List of Double instances that correspond to the rescaling factors across the segments.

Returns:

a List of Double

createStemTaperSegmentList

public static StemTaperSegmentList createStemTaperSegmentList(java.util.List<java.lang.Double> heights,
                                                              boolean optimize)

This static methods provides a list of StemTaperSegment instances embedded in a StemTaperSegmentList. The method optimizes the integration by using CompositeSimpsonRule numerical integration whenever possible. Otherwise, it uses TrapezoidalRule numerical integration.

Parameters:

heights - a List of Double instances that represent the heights along the bole

optimize - if false it disables the CompositeSimpsonRule and only the TrapezoidalRule is enabled

Returns:

a StemTaperSegmentList instance