1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * https://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18 /*
19 * This is not the original file distributed by the Apache Software Foundation
20 * It has been modified by the Hipparchus project
21 */
22 package org.hipparchus.geometry;
23
24 import java.io.Serializable;
25
26 /** This interface represents a generic geometrical point.
27 * @param <S> Type of the space.
28 * @param <P> Type of the points in space.
29 * @see Space
30 * @see Vector
31 */
32 public interface Point<S extends Space, P extends Point<S, P>> extends Serializable {
33
34 /** Get the space to which the point belongs.
35 * @return containing space
36 */
37 Space getSpace();
38
39 /**
40 * Returns true if any coordinate of this point is NaN; false otherwise
41 * @return true if any coordinate of this point is NaN; false otherwise
42 */
43 boolean isNaN();
44
45 /** Compute the distance between the instance and another point.
46 * @param p second point
47 * @return the distance between the instance and p
48 */
49 double distance(P p);
50
51 /** Move towards another point.
52 * <p>
53 * Motion is linear (along space curvature) and based on a ratio
54 * where 0.0 stands for not moving at all, 0.5 stands for moving halfway
55 * towards other point, and 1.0 stands for moving fully to the other point.
56 * </p>
57 * @param other other point
58 * @param ratio motion ratio,
59 * @return moved point
60 * @since 4.0
61 */
62 P moveTowards(P other, double ratio);
63
64 }