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.numbers.core;
18  
19  /**
20   * Operators that can be implemented in a more performant way
21   * using the language constructs.
22   *
23   * @param <T> Type of elements.
24   */
25  public interface NativeOperators<T>
26      extends Addition<T>,
27              Multiplication<T> {
28      /**
29       * Binary subtraction.
30       *
31       * @param a Element.
32       * @return {@code this - a}.
33       */
34      T subtract(T a);
35  
36      /**
37       * Binary division.
38       *
39       * @param a Element.
40       * @return {@code this / a}.
41       */
42      T divide(T a);
43  
44      /**
45       * Repeated addition.
46       *
47       * @param n Number of times to add {@code this} to itself.
48       * @return {@code n * this}.
49       */
50      T multiply(int n);
51  
52      /**
53       * Repeated multiplication.
54       *
55       * @param n Number of times to multiply {@code this} with itself.
56       * @return {@code this^n}.
57       */
58      T pow(int n);
59  }