All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.apache.commons.math3.geometry.partitioning.Embedding Maven / Gradle / Ivy

There is a newer version: 2.12.15
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.math3.geometry.partitioning;

import org.apache.commons.math3.geometry.Point;
import org.apache.commons.math3.geometry.Space;

/** This interface defines mappers between a space and one of its sub-spaces.

 * 

Sub-spaces are the lower dimensions subsets of a n-dimensions * space. The (n-1)-dimension sub-spaces are specific sub-spaces known * as {@link Hyperplane hyperplanes}. This interface can be used regardless * of the dimensions differences. As an example, {@link * org.apache.commons.math3.geometry.euclidean.threed.Line Line} in 3D * implements Embedding<{@link * org.apache.commons.math3.geometry.euclidean.threed.Vector3D Vector3D}, {link * org.apache.commons.math3.geometry.euclidean.oned.Vector1D Vector1D>, i.e. it * maps directly dimensions 3 and 1.

*

In the 3D euclidean space, hyperplanes are 2D planes, and the 1D * sub-spaces are lines.

*

* Note that this interface is not intended to be implemented * by Apache Commons Math users, it is only intended to be implemented * within the library itself. New methods may be added even for minor * versions, which breaks compatibility for external implementations. *

* @param Type of the embedding space. * @param Type of the embedded sub-space. * @see Hyperplane * @since 3.0 */ public interface Embedding { /** Transform a space point into a sub-space point. * @param point n-dimension point of the space * @return (n-1)-dimension point of the sub-space corresponding to * the specified space point * @see #toSpace */ Point toSubSpace(Point point); /** Transform a sub-space point into a space point. * @param point (n-1)-dimension point of the sub-space * @return n-dimension point of the space corresponding to the * specified sub-space point * @see #toSubSpace */ Point toSpace(Point point); }