org.nd4j.autodiff.validation.functions.RelErrorFn Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of nd4j-api Show documentation
The newest version!
/*
 *  ******************************************************************************
 *  *
 *  *
 *  * This program and the accompanying materials are made available under the
 *  * terms of the Apache License, Version 2.0 which is available at
 *  * https://www.apache.org/licenses/LICENSE-2.0.
 *  *
 *  *  See the NOTICE file distributed with this work for additional
 *  *  information regarding copyright ownership.
 *  * 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.
 *  *
 *  * SPDX-License-Identifier: Apache-2.0
 *  *****************************************************************************
 */

package org.nd4j.autodiff.validation.functions;

import lombok.AllArgsConstructor;
import lombok.Data;
import org.nd4j.linalg.api.iter.NdIndexIterator;
import org.nd4j.linalg.api.ndarray.INDArray;
import org.nd4j.common.function.Function;

import java.util.Arrays;

@AllArgsConstructor
@Data
public class RelErrorFn implements Function {

    private final INDArray expected;
    private final double maxRelativeError;
    private final double minAbsoluteError;
    

    @Override
    public String apply(INDArray actual) {
        //TODO switch to binary relative error ops
        if(!Arrays.equals(expected.shape(), actual.shape())){
            throw new IllegalStateException("Shapes differ! " + Arrays.toString(expected.shape()) + " vs " + Arrays.toString(actual.shape()));
        }

        NdIndexIterator iter = new NdIndexIterator(expected.shape());
        while(iter.hasNext()){
            long[] next = iter.next();
            double d1 = expected.getDouble(next);
            double d2 = actual.getDouble(next);
            if(d1 == 0.0 && d2 == 0){
                continue;
            }
            if(Math.abs(d1-d2) < minAbsoluteError){
                continue;
            }
            double re = Math.abs(d1-d2) / (Math.abs(d1) + Math.abs(d2));
            if(re > maxRelativeError){
                return "Failed on relative error at position " + Arrays.toString(next) + ": relativeError=" + re + ", maxRE=" + maxRelativeError + ", absError=" +
                        Math.abs(d1-d2) + ", minAbsError=" + minAbsoluteError + " - values (" + d1 + "," + d2 + ")";
            }
        }
        return null;
    }
}