TDA4j
API
Generated with
TDA4j/org.appliedtopology.tda4j/org.appliedtopology.tda4j.cells/Cube

Cube

org.appliedtopology.tda4j.cells.Cubical$package.Cube
object Cube

Attributes

Experimental
true
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Cube.type

Members list

Value members

Concrete methods

def apply(lower: Seq[Int], nondegenerate: Set[Int]): Cube

General constructor: lower gives each axis's lower lattice coordinate, nondegenerate marks which axes are unit intervals (every other axis is a degenerate point at its own lower value).

General constructor: lower gives each axis's lower lattice coordinate, nondegenerate marks which axes are unit intervals (every other axis is a degenerate point at its own lower value).

Attributes

def fromEncoded(coords: Seq[Int]): Cube

The primitive constructor every other one below reduces to: direct doubled-coordinate encoding (2*a = degenerate {a}, 2*a+1 = unit interval [a,a+1]), one entry per ambient axis.

The primitive constructor every other one below reduces to: direct doubled-coordinate encoding (2*a = degenerate {a}, 2*a+1 = unit interval [a,a+1]), one entry per ambient axis.

Attributes

def fromEncoded(coords: Int*): Cube
def unapplySeq(cube: Cube): Option[Seq[Int]]
def unitCube(coords: Seq[Int]): Cube

The top-dimensional cube (every axis non-degenerate) whose lower corner sits at lattice point coords -- e.g. the cube corresponding to pixel/voxel coords in a dense grid.

The top-dimensional cube (every axis non-degenerate) whose lower corner sits at lattice point coords -- e.g. the cube corresponding to pixel/voxel coords in a dense grid.

Attributes

def unitCube(coords: Int*): Cube
def vertex(coords: Seq[Int]): Cube

The vertex (0-dimensional cube, every axis degenerate) at integer lattice point coords.

The vertex (0-dimensional cube, every axis degenerate) at integer lattice point coords.

Attributes

def vertex(coords: Int*): Cube

Extensions

Extensions

extension (c: Cube)
def encoded: Vector[Int]
extension (c: Cube)
def ambientDim: Int

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Attributes

def isDegenerate(axis: Int): Boolean

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Attributes

def isNondegenerate(axis: Int): Boolean

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Attributes

def isTop: Boolean

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Attributes

def isVertex: Boolean

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Attributes

def latticeCoordinates: Seq[Int]

Lattice coordinates: for a top-dimensional cube (every axis non-degenerate) this is exactly the pixel/voxel grid index it corresponds to.

Lattice coordinates: for a top-dimensional cube (every axis non-degenerate) this is exactly the pixel/voxel grid index it corresponds to.

Attributes

def lowerCoordinate(axis: Int): Int

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Attributes

def nondegenerateAxes: Seq[Int]

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Attributes

def show: String

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Ergonomic accessors, kept distinct from dim/boundary (which live on the OrderedCell instance below, per Simplex.scala's own convention of putting the Cell/OrderedCell contract methods only there).

Attributes

Generated with