org.tensorics.core.scalar.lang.OngoingDeferredBinaryOperation 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.expressions.BinaryOperationExpression;
import org.tensorics.core.expressions.UnaryOperationExpression;
import org.tensorics.core.math.ExtendedField;
import org.tensorics.core.tree.domain.Expression;
import org.tensorics.core.tree.domain.ResolvedExpression;

/**
 * Provides methods to describe the right hand part of a binary operations for scalar expressions.
 * 
 * This class is part of the tensorcs fluent API.
 *
 * @param  the type of the scalar values (elements of the field)
 * @author kfuchsbe
 */
@SuppressWarnings("PMD.TooManyMethods")
public class OngoingDeferredBinaryOperation {

    private final ExtendedField field;
    private final Expression left;

    public OngoingDeferredBinaryOperation(ExtendedField field, Expression left) {
        this.field = field;
        this.left = left;
    }

    public Expression plus(S right) {
        return plus(ResolvedExpression.of(right));
    }

    public Expression plus(Expression right) {
        return new BinaryOperationExpression<>(field.addition(), left, right);
    }

    public Expression minus(S right) {
        return minus(ResolvedExpression.of(right));
    }

    public Expression minus(Expression right) {
        return new BinaryOperationExpression<>(field.subtraction(), left, right);
    }

    public Expression times(S right) {
        return times(ResolvedExpression.of(right));
    }

    public Expression times(Expression right) {
        return new BinaryOperationExpression<>(field.multiplication(), left, right);
    }

    public Expression dividedBy(S right) {
        return dividedBy(ResolvedExpression.of(right));
    }

    public Expression dividedBy(Expression right) {
        return new BinaryOperationExpression<>(field.division(), left, right);
    }

    public Expression toThePowerOf(S power) {
        return toThePowerOf(ResolvedExpression.of(power));
    }

    public Expression toThePowerOf(Expression power) {
        return new BinaryOperationExpression<>(field.power(), left, power);
    }

    public Expression root(S root) {
        return root(ResolvedExpression.of(root));
    }

    public Expression root(Expression root) {
        return new BinaryOperationExpression<>(field.power(), left, inverseOf(root));
    }

    private UnaryOperationExpression inverseOf(Expression value) {
        return new UnaryOperationExpression(field.multiplicativeInversion(), value);
    }

}