Sphere1D (Hipparchus 1.4 API)

java.lang.Object
- org.hipparchus.geometry.spherical.oned.Sphere1D

All Implemented Interfaces:

Serializable, Space
```
public class Sphere1D
extends Object
implements Serializable, Space
```
This class implements a one-dimensional sphere (i.e. a circle).
We use here the topologists definition of the 1-sphere (see Sphere on MathWorld), i.e. the 1-sphere is the one-dimensional closed curve defined in 2D as x²+y²=1.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Sphere1D.NoSubSpaceException
Specialized exception for inexistent sub-space.

Field Summary

Fields
Modifier and Type Field Description

static double SMALLEST_TOLERANCE
Smallest tolerance that can be managed.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static void`	`checkTolerance(double tolerance)`	Check tolerance against `SMALLEST_TOLERANCE`.
`int`	`getDimension()`	Get the dimension of the space.
`static Sphere1D`	`getInstance()`	Get the unique instance.
`Space`	`getSubSpace()`	Get the n-1 dimension subspace of this space.

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

- Field Detail
  - SMALLEST_TOLERANCE
```
public static final double SMALLEST_TOLERANCE
```
    Smallest tolerance that can be managed.
    Tolerances smaller than this value will generate exceptions.
    
    Since:
    
    1.4
- Method Detail
  - getInstance
```
public static Sphere1D getInstance()
```
    Get the unique instance.
    
    Returns:
    
    the unique instance
  - checkTolerance
```
public static void checkTolerance(double tolerance)
                           throws MathIllegalArgumentException
```
    Check tolerance against SMALLEST_TOLERANCE.
    
    Parameters:
    
    tolerance - tolerance to check
    
    Throws:
    
    MathIllegalArgumentException - if tolerance is smaller than SMALLEST_TOLERANCE
  - getDimension
```
public int getDimension()
```
    Get the dimension of the space.
    
    Specified by:
    
    getDimension in interface Space
    
    Returns:
    
    dimension of the space
  - getSubSpace
```
public Space getSubSpace()
                  throws Sphere1D.NoSubSpaceException
```
    Get the n-1 dimension subspace of this space.
    As the 1-dimension sphere does not have proper sub-spaces, this method always throws a Sphere1D.NoSubSpaceException
    
    Specified by:
    
    getSubSpace in interface Space
    
    Returns:
    
    nothing
    
    Throws:
    
    Sphere1D.NoSubSpaceException - in all cases
    
    See Also:
    
    Space.getDimension()