smile.deep.activation.ActivationFunction Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smile-deep Show documentation
smile-deep
The newest version!
/*
 * Copyright (c) 2010-2024 Haifeng Li. All rights reserved.
 *
 * Smile is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Smile is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Smile.  If not, see .
 */

package smile.deep.activation;

import java.io.Serializable;
import org.bytedeco.pytorch.Module;
import smile.deep.layer.Layer;

/**
 * The activation function. It also implements the layer interface
 * so that it can be treated added into a network as a layer.
 *
 * @author Haifeng Li
 */
public abstract class ActivationFunction implements Layer, Serializable {
    /** The module of activation function. */
    final Module module;
    /** The function name. */
    final String name;
    /** True if the operation executes in-place. */
    final boolean inplace;

    /**
     * Constructor.
     * @param name the function name.
     * @param inplace true if the operation executes in-place.
     */
    public ActivationFunction(String name, boolean inplace) {
        this.module = new Module(name);
        this.name = name;
        this.inplace = inplace;
    }

    /**
     * Returns the name of activation function.
     * @return the name of activation function.
     */
    public String name() {
        return name;
    }

    /**
     * Returns true if the operation executes in-place.
     * @return true if the operation executes in-place.
     */
    public boolean isInplace() {
        return inplace;
    }

    @Override
    public Module asTorch() {
        return module;
    }
}