001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.geometry.core;
018
019/** Interface representing a generic element in a mathematical space.
020 */
021public interface Spatial {
022
023    /** Returns the number of dimensions in the space that this element
024     * belongs to.
025     * @return the number of dimensions in the element's space
026     */
027    int getDimension();
028
029    /** Returns true if any value in this element is NaN; otherwise
030     * returns false.
031     * @return true if any value in this element is NaN
032     */
033    boolean isNaN();
034
035    /** Returns true if any value in this element is infinite and none
036     * are NaN; otherwise, returns false.
037     * @return true if any value in this element is infinite and none
038     *      are NaN
039     */
040    boolean isInfinite();
041
042    /** Returns true if all values in this element are finite, meaning
043     * they are not NaN or infinite.
044     * @return true if all values in this element are finite
045     */
046    boolean isFinite();
047}