View Javadoc

    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    *      http://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  package org.apache.commons.geometry.core;
    18
    19  /** Interface representing a generic element in a mathematical space.
    20   */
    21  public interface Spatial {
    22
    23      /** Returns the number of dimensions in the space that this element
    24       * belongs to.
    25       * @return the number of dimensions in the element's space
    26       */
    27      int getDimension();
    28
    29      /** Returns true if any value in this element is NaN; otherwise
    30       * returns false.
    31       * @return true if any value in this element is NaN
    32       */
    33      boolean isNaN();
    34
    35      /** Returns true if any value in this element is infinite and none
    36       * are NaN; otherwise, returns false.
    37       * @return true if any value in this element is infinite and none
    38       *      are NaN
    39       */
    40      boolean isInfinite();
    41
    42      /** Returns true if all values in this element are finite, meaning
    43       * they are not NaN or infinite.
    44       * @return true if all values in this element are finite
    45       */
    46      boolean isFinite();
    47  }