Package org.xmlcml.euclid

Interface Summary

Interface	Description
EC	alias for brevity.
EuclidConstants	Constants

Class Summary

Class	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.
ArrayBase	super class of array methods
Axis	enums to represent 2- or 3-D axes
Bivariate
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.
DoubleTool	Tool providing methods for working with doubles.
EuclidTestUtils	contains tests for equality, etc.
Int	Int supports various utilities for integers Use Integer where you want a first-class Java object
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.
JodaDate	really just to remember at this stage
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
Line2AndReal2Calculator
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)
RandomNumberGenerator
Real	Real supports various utilities for real numbers Use Double where you want a first-class Java object
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.
Real2RangeComparator	comparator for use with TreeSet<Double> and other tools which normally require equals().
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.
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.
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().
RealRangeList	a sorted list of ranges.
RealSquareMatrix	square matrix class RealSquareMatrix represents a square m-x-m matrix.
StringComparator
Transform2	2-D transformation matrix class Transform2 represents a transformation matrix for 2-D objects.
Transform3	3-D transformation matrix class Transform3 represents a transformation matrix for 3-D objects.
Univariate	Univariate stats.
UnivariateBin	manages the contents of a Bin in Univariate as a sub-Univariate
Util	A number of miscellaneous tools.
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

Enum Summary

Enum	Description
Angle.Range	range
Angle.Units	units
ArrayBase.Trim
Axis.Axis2	enum for x y z axes
Axis.Axis3	3d axes
IntSquareMatrix.Type	type
Real2Range.BoxDirection
RealArray.Filter	filter
RealArray.Monotonicity
RealRange.Direction
RealSquareMatrix.Type	type
Transform2.Type	type
Transform3.Type	type
Util.Message	messages

Exception Summary

Exception	Description
EuclidException	replaces all Exceptions in jumbo.euclid with a single Exception.
EuclidRuntimeException	runtime exception for Euclid

Annotation Types Summary

Annotation Type	Description
Euclid	These routines have evolved over >10 years and have now settled down to primitive dataTypes to support CML.