Space

java.lang.Object
- etomica.space.Space

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Space1D, Space2D, Space3D
```
public abstract class Space
extends java.lang.Object
implements java.io.Serializable
```
Superclass for all Space instances. Space classes are factories for vectors, tensors, etc.

See Also:

Serialized Form

Constructor Summary

Constructors
Modifier Constructor Description

protected Space()

Constructors
Modifier	Constructor	Description
`protected`	`Space()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`abstract int`	`D()`
`int`	`getD()`
`static Space`	`getInstance(int D)`
`abstract double[]`	`makeArrayD(double d)`
`abstract int[]`	`makeArrayD(int i)`
`abstract IOrientation`	`makeOrientation()`
`abstract RotationTensor`	`makeRotationTensor()`
`abstract Tensor`	`makeTensor()`
`abstract Vector`	`makeVector()`
`static Vector`	`makeVector(double... a)`	Deprecated. use `Vector.of(double...)`
`static Vector`	`makeVector(int D)`	Returns a Vector from the space of the given dimension.
`static Vector`	`makeVector(int... k)`	Deprecated. use `Vector.of(int...)`
`Vector[]`	`makeVectorArray(int n)`	Makes an array of Vectors.
`abstract double`	`powerD(double a)`
`abstract int`	`powerD(int a)`
`abstract double`	`rootD(double a)`
`abstract double`	`sphereArea(double r)`	The surface "area" of the "sphere" defined in the D-dimensional space.
`abstract double`	`sphereVolume(double r)`	The "volume" of the "sphere" defined in the D-dimensional space.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Space
```
protected Space()
```
- Method Detail
  - getInstance
```
public static Space getInstance(int D)
```
    Parameters:
    
    D - the dimension of the requested space instance
    
    Returns:
    
    a space instance of the given dimension, which must be 1, 2, or 3.
    
    Throws:
    
    java.lang.IllegalArgumentException - if D is not 1, 2, or 3.
  - D
```
public abstract int D()
```
    Returns:
    
    the dimension of this space.
  - getD
```
public int getD()
```
  - rootD
```
public abstract double rootD(double a)
```
    Returns:
    
    the given value raised to the power 1/D, where D is the dimension of the space.
  - powerD
```
public abstract int powerD(int a)
```
    Returns:
    
    the given value raised to the Dth power, where D is the dimension of the space.
  - powerD
```
public abstract double powerD(double a)
```
    Returns:
    
    the given value raised to the Dth power, where D is the dimension of the space.
  - makeVector
```
public abstract Vector makeVector()
```
    Returns:
    
    a new Vector appropriate to the space.
  - makeOrientation
```
public abstract IOrientation makeOrientation()
```
    Returns:
    
    a new Orientation appropriate to the space.
  - makeTensor
```
public abstract Tensor makeTensor()
```
    Returns:
    
    a new Tensor appropriate to the space.
  - makeRotationTensor
```
public abstract RotationTensor makeRotationTensor()
```
    Returns:
    
    a new RotationTensor appropriate to the space.
  - makeArrayD
```
public abstract int[] makeArrayD(int i)
```
    Returns:
    
    an array of dimension D (as defined for this Space instance), with each element equal to the given value.
  - makeArrayD
```
public abstract double[] makeArrayD(double d)
```
    Returns:
    
    an array of dimension D (as defined for this Space instance), with each element equal to the given value.
  - sphereVolume
```
public abstract double sphereVolume(double r)
```
    The "volume" of the "sphere" defined in the D-dimensional space. In 1-D, this is twice the radius; in 2-D the area of the circle; in 3-D the volume of the sphere.
    
    Parameters:
    
    r - the radius
    
    Returns:
    
    the volume
  - sphereArea
```
public abstract double sphereArea(double r)
```
    The surface "area" of the "sphere" defined in the D-dimensional space. In 1-D this is zero; in 2-D the circumference of the circle; in 3-D the surface area of the sphere.
    
    Parameters:
    
    r - the sphere radius
    
    Returns:
    
    the area
  - makeVector
```
public static Vector makeVector(int D)
```
    Returns a Vector from the space of the given dimension.
    
    Throws:
    
    java.lang.IllegalArgumentException - if D is not 1, 2, or 3.
  - makeVector
```
@Deprecated
public static Vector makeVector(double... a)
```
    Deprecated. use Vector.of(double...)
    
    Returns a Vector initialized to the given set of values in the array. Spatial dimension of the Vector is determined by the length of a.
    
    Throws:
    
    java.lang.IllegalArgumentException - if a.length is not 1, 2, or 3.
  - makeVector
```
@Deprecated
public static Vector makeVector(int... k)
```
    Deprecated. use Vector.of(int...)
    
    Returns a Vector initialized to the given set of values in the array (cast to double). Spatial dimension of the Vector is determined by the length of a.
  - makeVectorArray
```
public Vector[] makeVectorArray(int n)
```
    Makes an array of Vectors.
    
    Parameters:
    
    n - number of vectors in the returned array
    
    Returns:
    
    an array of n new vectors made by this Space instance

Class Space

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Space

Method Detail

getInstance

D

getD

rootD

powerD

powerD

makeVector

makeOrientation

makeTensor

makeRotationTensor

makeArrayD

makeArrayD

sphereVolume

sphereArea

makeVector

makeVector

makeVector

makeVectorArray