org.tensorics.core.scalar.lang.OngoingScalarBinaryOperation 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.scalar.lang;

import org.tensorics.core.commons.lang.OngoingBinaryOperation;
import org.tensorics.core.math.ExtendedField;
import org.tensorics.core.math.operations.BinaryOperation;

/**
 * Part of the tensorics fluent API that provides methods to describe the right hand side of binary operations on plain
 * scalars (field elements).
 * 
 * @author kfuchsbe
 * @param  the type of the scalars (field elements)
 */
@SuppressWarnings("PMD.TooManyMethods")
public class OngoingScalarBinaryOperation implements OngoingBinaryOperation {

    private final ExtendedField field;
    private final S left;

    public OngoingScalarBinaryOperation(ExtendedField field, S left) {
        this.field = field;
        this.left = left;
    }

    @Override
    public S plus(S right) {
        return addition().perform(left, right);
    }

    @Override
    public S minus(S right) {
        return subtraction().perform(left, right);
    }

    @Override
    public S times(S right) {
        return multiplication().perform(left, right);
    }

    @Override
    public S dividedBy(S right) {
        return division().perform(left, right);
    }

    @Override
    public final S toThePowerOf(S power) {
        return power().perform(left, power);
    }

    @Override
    public final S root(S element) {
        return power().perform(left, field.multiplicativeInversion().perform(element));
    }

    private final BinaryOperation addition() {
        return field.addition();
    }

    private final BinaryOperation subtraction() {
        return field.subtraction();
    }

    private final BinaryOperation multiplication() {
        return field.multiplication();
    }

    private final BinaryOperation division() {
        return field.division();
    }

    private BinaryOperation power() {
        return field.power();
    }

}