org.tensorics.core.testing.lang.OngoingCloseToMatcherCreation 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.lang;

import org.hamcrest.Matcher;
import org.tensorics.core.commons.options.Environment;
import org.tensorics.core.scalar.lang.ScalarSupport;
import org.tensorics.core.tensor.Tensor;
import org.tensorics.core.tensor.lang.TensorSupport;
import org.tensorics.core.testing.hamcrest.ScalarIsCloseTo;
import org.tensorics.core.testing.hamcrest.TensorIsCloseTo;

/**
 * Part of a fluent clause to create a matcher which will allow to check if some value is 'close to' some other value.
 * 
 * @author kfuchsbe
 * @param  the type of the scalar for which a matcher has to be created
 */
public class OngoingCloseToMatcherCreation {

    private final Environment environment;
    private final S tolerance;

    public OngoingCloseToMatcherCreation(Environment environment, S tolerance) {
        super();
        this.environment = environment;
        this.tolerance = tolerance;
    }

    public Matcher closeTo(S value) {
        return new ScalarIsCloseTo(new ScalarSupport<>(environment.field()), value, tolerance);
    }

    public Matcher> closeTo(Tensor tensor) {
        return new TensorIsCloseTo(new TensorSupport<>(environment), tensor, tolerance);
    }
}