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.numbers.core;
018
019/**
020 * Operators that can be implemented in a more performant way
021 * using the language constructs.
022 *
023 * @param <T> Type of elements.
024 */
025public interface NativeOperators<T>
026    extends Addition<T>,
027            Multiplication<T> {
028    /**
029     * Binary subtraction.
030     *
031     * @param a Element.
032     * @return {@code this - a}.
033     */
034    T subtract(T a);
035
036    /**
037     * Binary division.
038     *
039     * @param a Element.
040     * @return {@code this / a}.
041     */
042    T divide(T a);
043
044    /**
045     * Repeated addition.
046     *
047     * @param n Number of times to add {@code this} to itself.
048     * @return {@code n * this}.
049     */
050    T multiply(int n);
051
052    /**
053     * Repeated multiplication.
054     *
055     * @param n Number of times to multiply {@code this} with itself.
056     * @return {@code this^n}.
057     */
058    T pow(int n);
059}