Simplex (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractSet
  - - delaunay.Simplex

All Implemented Interfaces:

Iterable, Collection, Set
```
public class Simplex
extends AbstractSet
implements Set
```
A Simplex is an immutable set of vertices (usually Pnts).

Author:

Paul Chew Created July 2005. Derived from an earlier, messier version.

Field Summary

Fields
Modifier and Type Field and Description

static boolean moreInfo

Fields
Modifier and Type	Field and Description
`static boolean`	`moreInfo`

Constructor Summary

Constructors
Constructor and Description

Simplex(Collection collection)
Constructor.

Simplex(Object[] vertices)
Constructor.

Constructors
Constructor and Description
`Simplex(Collection collection)` Constructor.
`Simplex(Object[] vertices)` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Set`	`boundary(Set simplexSet)` Report the boundary of a Set of Simplices.
`int`	`dimension()` Dimension of the Simplex.
`boolean`	`equals(Object o)` We want to allow for different simplices that share the same vertex set.
`List`	`facets()` Report the facets of this Simplex.
`int`	`hashCode()`
`boolean`	`isNeighbor(Simplex simplex)` True iff simplices are neighbors.
`Iterator`	`iterator()`
`int`	`size()`
`String`	`toString()` String representation.

Methods inherited from class java.util.AbstractSet
removeAll

Methods inherited from class java.util.AbstractCollection
add, addAll, clear, contains, containsAll, isEmpty, remove, retainAll, toArray, toArray

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

Methods inherited from interface java.util.Set
add, addAll, clear, contains, containsAll, isEmpty, remove, removeAll, retainAll, spliterator, toArray, toArray

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Field Detail
  - moreInfo
```
public static boolean moreInfo
```
- Constructor Detail
  - Simplex
```
public Simplex(Collection collection)
```
    Constructor.
    
    Parameters:
    
    collection - a Collection holding the Simplex vertices
    
    Throws:
    
    IllegalArgumentException - if there are duplicate vertices
  - Simplex
```
public Simplex(Object[] vertices)
```
    Constructor.
    
    Parameters:
    
    vertices - the vertices of the Simplex.
    
    Throws:
    
    IllegalArgumentException - if there are duplicate vertices
- Method Detail
  - toString
```
public String toString()
```
    String representation.
    
    Overrides:
    
    toString in class AbstractCollection
    
    Returns:
    
    the String representation of this Simplex
  - dimension
```
public int dimension()
```
    Dimension of the Simplex.
    
    Returns:
    
    dimension of Simplex (one less than number of vertices)
  - isNeighbor
```
public boolean isNeighbor(Simplex simplex)
```
    True iff simplices are neighbors. Two simplices are neighbors if they are the same dimension and they share a facet.
    
    Parameters:
    
    simplex - the other Simplex
    
    Returns:
    
    true iff this Simplex is a neighbor of simplex
  - facets
```
public List facets()
```
    Report the facets of this Simplex. Each facet is a set of vertices.
    
    Returns:
    
    an Iterable for the facets of this Simplex
  - boundary
```
public static Set boundary(Set simplexSet)
```
    Report the boundary of a Set of Simplices. The boundary is a Set of facets where each facet is a Set of vertices.
    
    Returns:
    
    an Iterator for the facets that make up the boundary
  - iterator
```
public Iterator iterator()
```
    Specified by:
    
    iterator in interface Iterable
    
    Specified by:
    
    iterator in interface Collection
    
    Specified by:
    
    iterator in interface Set
    
    Specified by:
    
    iterator in class AbstractCollection
    
    Returns:
    
    Iterator for Simplex's vertices.
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection
    
    Specified by:
    
    size in interface Set
    
    Specified by:
    
    size in class AbstractCollection
    
    Returns:
    
    the size (# of vertices) of this Simplex
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection
    
    Specified by:
    
    hashCode in interface Set
    
    Overrides:
    
    hashCode in class AbstractSet
    
    Returns:
    
    the hashCode of this Simplex
  - equals
```
public boolean equals(Object o)
```
    We want to allow for different simplices that share the same vertex set.
    
    Specified by:
    
    equals in interface Collection
    
    Specified by:
    
    equals in interface Set
    
    Overrides:
    
    equals in class AbstractSet
    
    Returns:
    
    true for equal Simplices

Class Simplex

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.util.AbstractSet

Methods inherited from class java.util.AbstractCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Set

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Field Detail

moreInfo

Constructor Detail

Simplex

Simplex

Method Detail

toString

dimension

isNeighbor

facets

boundary

iterator

size

hashCode

equals