org.nd4j.linalg.api.ops.impl.scalar.LogX Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of nd4j-api Show documentation
There is a newer version: 1.0.0-M2.1
/*******************************************************************************
 * Copyright (c) 2015-2018 Skymind, Inc.
 *
 * 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.
 *
 * 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.linalg.api.ops.impl.scalar;

import org.nd4j.autodiff.functions.DifferentialFunction;
import org.nd4j.autodiff.samediff.SDVariable;
import org.nd4j.autodiff.samediff.SameDiff;
import org.nd4j.imports.NoOpNameFoundException;
import org.nd4j.linalg.api.ndarray.INDArray;
import org.nd4j.linalg.api.ops.BaseScalarOp;
import org.nd4j.linalg.api.ops.BaseTransformOp;

import java.util.Collections;
import java.util.List;

/**
 * Log on arbitrary base op
 *
 * @author [email protected]
 */
public class LogX extends BaseScalarOp {
    private double base;

    public LogX(SameDiff sameDiff, SDVariable i_v, double base) {
        super(sameDiff, i_v, base);
        this.base = base;
        this.extraArgs = new Object[] {base};
    }

    public LogX() {}

    public LogX(INDArray x, INDArray z, double base) {
        super(x, null, z, base);
        this.base = base;
        this.extraArgs = new Object[] {base};
    }

    public LogX(INDArray x, double base) {
        super(x, base);
        this.base = base;
        this.extraArgs = new Object[] {base};
    }

    @Override
    public int opNum() {
        return 38;
    }

    @Override
    public String opName() {
        return "log_x";
    }

    @Override
    public List doDiff(List f1) {
        //dlog_b(x)/dx = 1/(x*log_e(b))

        double logb = Math.log(base);
        return Collections.singletonList(f1.get(0).div(arg().mul(logb)));
    }

    @Override
    public String onnxName() {
        throw new NoOpNameFoundException("No onnx op opName found for " +  opName());
    }


    @Override
    public String tensorflowName() {
        return "LogX";
    }
}