Uses of Package
org.xmlcml.euclid

Packages that use org.xmlcml.euclid

Package	Description
org.xmlcml.euclid
org.xmlcml.stml
org.xmlcml.stml.attribute
org.xmlcml.xml

Classes in org.xmlcml.euclid used by org.xmlcml.euclid

Class and Description
Angle Angle object Angle represents an angle The reason for the class is to help remember about radian/degree problems, to keep the angle in the right range (0, 2*PI) or (-PI, PI) as required, and to format output.
Angle.Range range
Angle.Units units
ArrayBase super class of array methods
ArrayBase.Trim
Axis.Axis2 enum for x y z axes
Axis.Axis3 3d axes
Complex A complex number derived from Real2 Complex represents a complex number A reasonable number of arithmetic operations are included DeMoivre's theorem is used for some of them so there may be quicker implementations elsewhere.
EuclidConstants Constants
EuclidException replaces all Exceptions in jumbo.euclid with a single Exception.
EuclidRuntimeException runtime exception for Euclid
Int2 A pair of integers with no other assumptions Contains two ints.
Int2Range 2-D int limits Contains two IntRanges.
IntArray array of ints IntArray represents a 1-dimensional vector or array of ints and is basically a wrapper for int[] in Java There are a lot of useful member functions (sorting, ranges, parallel operations The default is an array with zero points All arrays are valid objects.
IntMatrix rectangular real number matrix class IntMatrix represents a rectangular m-x-n matrix.
IntRange maximum and minimum values Contains two ints representing the minimum and maximum of an allowed or observed range.
IntRangeArray holds an array of IntRanges may or may not overlap or be sorted
IntSet public class IntSet Stores a unique set of ints (that is cannot contain duplicate ints.
IntSquareMatrix square matrix class IntSquareMatrix represents a square m-x-m matrix.
IntSquareMatrix.Type type
Line2 line determined by one point (R) and a vector (V) this gives L = R + nV can assume that R and R+V are the two "ends of the line" the semantics of this are application-dependent
Line3 3-dimensional line class Line3 represents a 3-dimensional line It is one of a set of primitives which can be combined to create and manipulate complex 3-dimensional objects.
ParsedSymop Parses common crystallographic representations of a single component of a symmetry operator Lowercases everything e.g.
Plane3 3-dimensional plane class Plane3 represents a 3-dimensional plane.
Point2 2-dimensional point class PROBABLY OBSOLETE - WE USE Real2 instead Point2 represents a 2-dimensional point.
Point3 3-dimensional point class Point3 represents a 3-dimensional point.
Point3Vector a (Java) Vector of Point3s (Note that 'Vector' is used by Java to describe an array of objects - there is no relationship to geometrical vectors in this package.)
Polar Polar coordinates (r, theta)
Real2 A pair of FPt numbers with no other assumptions Contains two doubles Can be used as it is, but there are some specialised derived classes (for example Complex (a complex number), Point2 (x,y coords), etc), The default value is 0.0, 0.0.
Real2Array Real2Array is NOT a Vector of Real2s but a container for a 2 * n matrix with a variety of ways of managing the data including RealArrays for the x and y arrays, and also an array of Real2s The latter is only stored if required, and then is cached.
Real2Interval a two dimensional area.
Real2Range 2-D double limits Contains two RealRanges.
Real2Range.BoxDirection
Real2Vector a (Java) Vector of Real2s (Note that 'Vector' is used by Java to describe an array of objects - there is no relationship to geometrical vectors in this package.)
Real3Range 3-D double limits Contains 3 RealRanges.
RealArray array of doubles RealArray represents a 1-dimensional array of doubles and is basically a wrapper for double[] in Java There are a lot of useful member functions (sorting, ranges, parallel operations The default is an array with zero points All arrays are valid objects.
RealArray.Filter filter
RealArray.Monotonicity
RealComparator comparator for use with TreeSet<Double> and other tools which normally require equals().
RealInterval an interval on the real line.
RealMatrix rectangular real number matrix class RealMatrix represents a rectangular m-x-n matrix.
RealRange maximum and minimum values Contains two doubles representing the minimum and maximum of an allowed or observed range.
RealRange.Direction
RealRangeArray holds an array of RealRanges may or may not overlap or be sorted perhaps replace by Google rangeSet of IntervalTree later
RealRangeComparator comparator for use with TreeSet<Double> and other tools which normally require equals().
RealSquareMatrix square matrix class RealSquareMatrix represents a square m-x-m matrix.
RealSquareMatrix.Type type
Transform2 2-D transformation matrix class Transform2 represents a transformation matrix for 2-D objects.
Transform2.Type type
Transform3 3-D transformation matrix class Transform3 represents a transformation matrix for 3-D objects.
Transform3.Type type
Univariate Univariate stats.
Util.Message messages
Vector2 a 2-D vector relationship with Complex and Polar not fully worked out.
Vector3 3-dimensional vector A vector has thre components giving it a length and a direction (whose sign is important),but no position.
Window2 a 2D window (bounding box, viewport, etc) Used with Transform2

Classes in org.xmlcml.euclid used by org.xmlcml.stml

Class and Description
EuclidConstants Constants
RealArray array of doubles RealArray represents a 1-dimensional array of doubles and is basically a wrapper for double[] in Java There are a lot of useful member functions (sorting, ranges, parallel operations The default is an array with zero points All arrays are valid objects.

Classes in org.xmlcml.euclid used by org.xmlcml.stml.attribute

Class and Description
EuclidConstants Constants

Classes in org.xmlcml.euclid used by org.xmlcml.xml

Class and Description
EuclidConstants Constants