org.tensorics.core.testing.hamcrest.ScalarIsCloseTo 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.testing.hamcrest;

import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;

import org.hamcrest.Description;
import org.hamcrest.TypeSafeMatcher;
import org.tensorics.core.scalar.lang.ScalarSupport;

/**
 * A matcher for unit tests, that allows to set a tolerance value. This matcher uses the scalar support of tensorics,
 * thus it can be used on any scalars fro which a field is provided.
 * 
 * @author kfuchsbe
 * @param  the type of the scalars (elements of the field)
 */
public class ScalarIsCloseTo extends TypeSafeMatcher {

    private final ScalarSupport support;
    private final S value;
    private final S tolerance;

    public ScalarIsCloseTo(ScalarSupport scalarSupport, S value, S tolerance) {
        super();
        this.support = checkNotNull(scalarSupport, "scalarSupport must not be null");
        this.value = checkNotNull(value, "value must not be null");
        this.tolerance = checkNotNull(tolerance, "tolerance must not be null");
        checkArgument(support.testIf(tolerance).isGreaterOrEqualTo(support.zero()), "Tolerance must be positive.");
    }

    @Override
    public void describeTo(Description description) {
        description.appendText("within " + tolerance + " close to " + value);
    }

    @Override
    protected boolean matchesSafely(S valueToAssert) {
        S diff = support.calculate(valueToAssert).minus(value);
        S absoluteDiff = support.absoluteValueOf(diff);
        return support.testIf(absoluteDiff).isLessOrEqualTo(tolerance);
    }

}