Package org.apache.commons.geometry.core

Interface Embedding<P extends Point<P>,S extends Point<S>>

Type Parameters:
P - Point type defining the embedding space.
S - Point type defining the embedded subspace.
All Known Subinterfaces:
EmbeddingHyperplane<P,S>, PlaneConvexSubset.Embedded, PlaneSubset.Embedded, RegionEmbedding<P,S>
All Known Implementing Classes:
AbstractEmbeddedRegionPlaneSubset, EmbeddedAreaPlaneConvexSubset, EmbeddedTreeGreatCircleSubset, EmbeddedTreeLineSubset, EmbeddedTreeLineSubset3D, EmbeddedTreePlaneSubset, EmbeddingPlane, GreatArc, GreatCircle, GreatCircleSubset, Line, Line3D, LineConvexSubset, LineConvexSubset3D, LineSpanningSubset, LineSpanningSubset3D, LineSubset, LineSubset3D, Ray, Ray3D, ReverseRay, ReverseRay3D, Segment, Segment3D
public interface Embedding<P extends Point<P>,S extends Point<S>>
This interface defines mappings between a space and one of its subspaces.

Subspaces are the lower-dimension subsets of a space. For example, in an n-dimension space, the subspaces are the (n-1) dimension space, the (n-2) dimension space, and so on. This interface can be used regardless of the difference in number of dimensions between the space and the target subspace. For example, a line in 3D Euclidean space can use this interface to map directly from 3D Euclidean space to 1D Euclidean space (ie, the location along the line).

  • Method Summary

    Modifier and Type
    Method
    Description
    default List<P>
    toSpace(Collection<S> pts)
    Transform a collection of subspace points into space points.
    P
    toSpace(S pt)
    Transform a subspace point into a space point.
    default List<S>
    toSubspace(Collection<P> pts)
    Transform a collection of space points into subspace points.
    S
    toSubspace(P pt)
    Transform a space point into a subspace point.

  • Method Details

    • toSubspace

      S toSubspace(P pt)
      Transform a space point into a subspace point.
      Parameters:
      pt - n-dimension point of the space
      Returns:
      lower-dimension point of the subspace corresponding to the specified space point
      See Also:

    • toSubspace

      default List<S> toSubspace(Collection<P> pts)
      Transform a collection of space points into subspace points.
      Parameters:
      pts - collection of n-dimension points to transform
      Returns:
      collection of transformed lower-dimension points.
      See Also:

    • toSpace

      P toSpace(S pt)
      Transform a subspace point into a space point.
      Parameters:
      pt - lower-dimension point of the subspace
      Returns:
      n-dimension point of the space corresponding to the specified subspace point
      See Also:

    • toSpace

      default List<P> toSpace(Collection<S> pts)
      Transform a collection of subspace points into space points.
      Parameters:
      pts - collection of lower-dimension points to transform
      Returns:
      collection of transformed n-dimension points.
      See Also: