org.tensorics.core.math.ExplicitField Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of tensorics-core Show documentation

Tensorics is a java framework which uses a tensor as a central object. A tensor represents a set of values placed in an N-dimensional space. Wherever you are tempted to use maps of maps, a tensor might be a good choice ;-) Tensorics provides methods to create, transform and performing calculations with those tensors.

There is a newer version: 0.0.81

Show newest version

// @formatter:off
 /*******************************************************************************
 *
 * This file is part of tensorics.
 * 
 * Copyright (c) 2008-2011, CERN. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 ******************************************************************************/
// @formatter:on

package org.tensorics.core.math;

import java.util.Comparator;

import org.tensorics.core.math.operations.BinaryOperation;
import org.tensorics.core.math.operations.UnaryOperation;
import org.tensorics.core.math.predicates.BinaryPredicate;

/**
 * A more explicit view on the algebraic structure of a field. It provides more dedicated operations.
 * 
 * @param  the type of the elements of the field
 */
@SuppressWarnings("PMD.TooManyMethods")
public interface ExplicitField {

    /**
     * Has to return the '+' operation.
     * 
     * @return the operation which can perform a + b.
     */
    BinaryOperation addition();

    UnaryOperation additiveInversion();

    BinaryOperation subtraction();

    T zero();

    /**
     * Has to return the '*' operation.
     * 
     * @return the operation which can perform a * b.
     */
    BinaryOperation multiplication();

    BinaryOperation division();

    UnaryOperation multiplicativeInversion();

    T one();

    T two();

    BinaryPredicate less();

    BinaryPredicate lessOrEqual();

    BinaryPredicate equal();

    BinaryPredicate greaterOrEqual();

    BinaryPredicate greater();

    Comparator comparator();
}