org.tensorics.core.scalar.lang.ScalarSupport 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.BasicOperationSupport;
import org.tensorics.core.commons.lang.OngoingBinaryOperation;
import org.tensorics.core.math.ExtendedField;

/**
 * Contains the starting methods for tensoric eDSL language expressions, related to basic operations of scalar values
 * (field elements). The class is designed that it can be used in both ways: Either that it can be instantiated or that
 * other classes can inherit from it. The latter option makes the language expressions very concise.
 * 
 * @author kfuchsbe
 * @param  the type of the scalar values (elements of the fields) on which to operate
 */
@SuppressWarnings("PMD.TooManyMethods")
public class ScalarSupport implements BasicOperationSupport {

    private final ExtendedField field;

    public ScalarSupport(ExtendedField field) {
        this.field = field;
    }

    @Override
    public OngoingBinaryOperation calculate(V operand) {
        return new OngoingScalarBinaryOperation(this.field, operand);
    }

    public OngoingScalarBinaryPredicate testIf(V left) {
        return new OngoingScalarBinaryPredicate(field, left);
    }

    @Override
    public final V negativeOf(V element) {
        return this.field.additiveInversion().perform(element);
    }

    @Override
    public final V inverseOf(V element) {
        return this.field.multiplicativeInversion().perform(element);
    }

    public final V zero() {
        return this.field.zero();
    }

    public final V two() {
        return calculate(one()).plus(one());
    }

    public final V one() {
        return this.field.one();
    }

    public V countOf(int number) {
        V one = one();
        V count = zero();
        for (int i = 0; i < number; i++) {
            count = calculate(count).plus(one);
        }
        return count;
    }

    @Override
    public V squareRootOf(V value) {
        return calculate(value).root(two());
    }

    @Override
    public V squareOf(V value) {
        return calculate(value).toThePowerOf(two());
    }

    @Override
    public V absoluteValueOf(V value) {
        return squareRootOf(squareOf(value));
    }

}