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 geometric element with a size. The exact meaning
    20   * of the size will vary between spaces and dimensions. For example, the size
    21   * of a line is its length, while the size of a polygon is its area.
    22   */
    23  public interface Sized {
    24
    25      /** Get the size of the instance.
    26       * @return the size of the instance
    27       */
    28      double getSize();
    29
    30      /** Return true if the size of the instance is finite.
    31       * @return true if the size of the instance is finite
    32       */
    33      default boolean isFinite() {
    34          return Double.isFinite(getSize());
    35      }
    36
    37      /** Return true if the size of the instance is infinite.
    38       * @return true if the size of the instance is infinite
    39       */
    40      default boolean isInfinite() {
    41          return Double.isInfinite(getSize());
    42      }
    43  }