Package xal.tools.math.r3

Class ClosedBox

java.lang.Object

xal.tools.math.r3.ClosedBox

All Implemented Interfaces:

Serializable

public class ClosedBox
extends Object
implements Serializable

Represents a Cartesian box in R³.

Since:

Jan 27, 2003

Author:

Christopher K. Allen

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ClosedBox()	Default constructor - creates an empty DomainR3 object to be initialized by the user
ClosedBox(double xmin, double xmax, double ymin, double ymax, double zmin, double zmax)	Initializing constructor - creates a new instance of DomainR3 according to the given parameters.
ClosedBox(ClosedInterval i1, ClosedInterval i2, ClosedInterval i3)	Initializing constructor - creates a new instance of DomainR3 according to the given parameters.

Method Summary

Modifier and Type	Method	Description
boolean	boundary(R3 pt)	Determine whether or not point pt is member of the boundary of this set.
R3	centroid()	Compute the centroid of the domain
double	diameter()	Computes the diameter of the domain.
R3	dimensions()	Compute the dimensions of the domain
ClosedInterval	get1()	Get first dimension extent
ClosedInterval	get2()	Get second dimension extent
ClosedInterval	get3()	Get second dimension extent
R3	getVertexMax()	Get the maximum vertex
R3	getVertexMin()	Get the minimum vertex
ClosedInterval	getXDimension()	Get the x dimension
ClosedInterval	getYDimension()	Get the y dimension
ClosedInterval	getZDimension()	Get the z dimension
boolean	membership(R3 pt)	Determine whether point pt is an element of the domain.
void	print(PrintWriter os)	Print out contents on an output stream
void	println(PrintWriter os)	Print out contents on an output stream, terminate in newline character
double	volume()	Compute the volume of the domain.

Methods inherited from class java.lang.Object

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

Constructor Details

ClosedBox

public ClosedBox()

Default constructor - creates an empty DomainR3 object to be initialized by the user

ClosedBox

public ClosedBox(ClosedInterval i1,
 ClosedInterval i2,
 ClosedInterval i3)

Initializing constructor - creates a new instance of DomainR3 according to the given parameters.

Parameters:

i1 - interval of definition in x dimension

i2 - interval of definition in y dimension

i3 - interval of definition in z dimension

ClosedBox

public ClosedBox(double xmin,
 double xmax,
 double ymin,
 double ymax,
 double zmin,
 double zmax)
          throws MathException

Initializing constructor - creates a new instance of DomainR3 according to the given parameters. Not that the box is defined by the intervals [xmin,xmax] interval of definition in x dimension [ymin,ymax] interval of definition in y dimension [zmin,zmax] interval of definition in z dimension

Parameters:

xmin - x dimension minimum value

xmax - x dimension maximum value

ymin - y dimension minimum value

ymax - y dimension maximum value

zmin - z dimension minimum value

zmax - z dimension maximum value

Throws:

MathException - one or more axis intervals are malformed (i.e., α_max < α_min, where α ∈ {x,y,z})

Method Details

get1

public ClosedInterval get1()

Get first dimension extent

get2

public ClosedInterval get2()

Get second dimension extent

get3

public ClosedInterval get3()

Get second dimension extent

getXDimension

public ClosedInterval getXDimension()

Get the x dimension

getYDimension

public ClosedInterval getYDimension()

Get the y dimension

getZDimension

public ClosedInterval getZDimension()

Get the z dimension

getVertexMin

public R3 getVertexMin()

Get the minimum vertex

getVertexMax

public R3 getVertexMax()

Get the maximum vertex

membership

public boolean membership(R3 pt)

Determine whether point pt is an element of the domain.

Returns:

true if pt is in domain

boundary

public boolean boundary(R3 pt)

Determine whether or not point pt is member of the boundary of this set.

Returns:

true if pt is a boundary element

centroid

public R3 centroid()

Compute the centroid of the domain

diameter

public double diameter()

Computes the diameter of the domain.

volume

public double volume()

Compute the volume of the domain.

dimensions

public R3 dimensions()

Compute the dimensions of the domain

Returns:

(lx,ly,lz)

print

public void print(PrintWriter os)

Print out contents on an output stream

Parameters:

os - output stream receiving content dump

println

public void println(PrintWriter os)

Print out contents on an output stream, terminate in newline character

Parameters:

os - output stream receiving content dump