org.tensorics.core.tensor.lang.OngoingStructuralReduction Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of tensorics-core Show documentation
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.
// @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.tensor.lang;
import org.tensorics.core.reduction.ReductionStrategy;
import org.tensorics.core.reduction.Slicing;
import org.tensorics.core.tensor.Tensor;
import org.tensorics.core.tensor.operations.TensorReduction;
/**
* Part of the tensoric fluent API, which provides methods to specify concretely how a given dimension should be
* reduced.
*
* @author kfuchsbe
* @param the type of coordinate (aka 'the dimension') which is going to be reduced (by calling methods of this
* class)
* @param the type of the elements of the tensor to be reduced.
*/
public class OngoingStructuralReduction {
private final Tensor tensor;
private final Class dimension;
public OngoingStructuralReduction(Tensor tensor, Class dimension) {
this.tensor = tensor;
this.dimension = dimension;
}
@SuppressWarnings("PMD.ShortMethodName")
public Tensor by(ReductionStrategy strategy) {
return reduceBy(strategy);
}
public Tensor bySlicingAt(C slicePosition) {
return reduceBy(new Slicing(slicePosition));
}
public > OngoingStructuralReductionOptions byInterpolatedSlicingAt(C slicePosition) {
return new OngoingStructuralReductionOptions(slicePosition, tensor, dimension);
}
protected Tensor reduceBy(ReductionStrategy strategy) {
return new TensorReduction<>(dimension, strategy).apply(tensor);
}
}