Package etomica.math.geometry

Class Hypersphere

java.lang.Object

etomica.math.geometry.Hypersphere

All Implemented Interfaces:

Shape, java.io.Serializable

Direct Known Subclasses:

Circle, Sphere

public class Hypersphere
extends java.lang.Object
implements Shape, java.io.Serializable

An arbitrary-dimension sphere.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected double	radius

Constructor Summary

Constructors

Constructor	Description
Hypersphere(int D)	Creates hypersphere of the given dimension, positioned at the origin.
Hypersphere(int D, double radius)	Creates hypersphere of the given dimension and radius, positioned at the origin.

Method Summary

Modifier and Type	Method	Description
boolean	contains(Vector r)	Returns true if the given point lies on or in the sphere.
int	D()	Returns the spatial dimension of the shape.
Vector	getPosition()
double	getRadius()
double	getVolume()	Returns the (hyper-)volume of the enclosed region.
void	setPosition(Vector position)	Sets the position of the shape, which typically represents some central point within it.
void	setRadius(double radius)

Methods inherited from class java.lang.Object

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

Field Detail

radius

protected double radius

Constructor Detail

Hypersphere

public Hypersphere(int D)

Creates hypersphere of the given dimension, positioned at the origin.

Hypersphere

public Hypersphere(int D,
                   double radius)

Creates hypersphere of the given dimension and radius, positioned at the origin.

Method Detail

getVolume

public double getVolume()

Description copied from interface: Shape

Returns the (hyper-)volume of the enclosed region. In 1D this is a length, in 2D it is an area, in 3D it is a volume.

Specified by:

getVolume in interface Shape

D

public final int D()

Description copied from interface: Shape

Returns the spatial dimension of the shape. For example, D = 2 for a square, D = 3 for a cube.

Specified by:

D in interface Shape

contains

public boolean contains(Vector r)

Returns true if the given point lies on or in the sphere.

Specified by:

contains in interface Shape

Throws:

java.lang.ClassCastException - if given vector is not an instance of a D-dimensional vector

getRadius

public double getRadius()

Returns:

Returns the radius.

setRadius

public void setRadius(double radius)

Parameters:

radius - The radius to set.

getPosition

public Vector getPosition()

Returns:

Returns the vector (not a copy) used to represent the position of the sphere.

setPosition

public void setPosition(Vector position)

Description copied from interface: Shape

Sets the position of the shape, which typically represents some central point within it. Specific definition depends on the definition of the shape.

Specified by:

setPosition in interface Shape

Parameters:

position - The new position, which is copied to an internal vector.