org.tribuo.math.kernel.Sigmoid Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tribuo-math Show documentation

There is a newer version: 4.3.1

/*
 * Copyright (c) 2015-2020, Oracle and/or its affiliates. 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 implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.tribuo.math.kernel;

import com.oracle.labs.mlrg.olcut.config.Config;
import com.oracle.labs.mlrg.olcut.provenance.ConfiguredObjectProvenance;
import com.oracle.labs.mlrg.olcut.provenance.impl.ConfiguredObjectProvenanceImpl;
import org.tribuo.math.la.SparseVector;

/**
 * A sigmoid kernel, tanh(gamma*u.dot(v) + intercept).
 */
public class Sigmoid implements Kernel {
    private static final long serialVersionUID = 1L;

    @Config(mandatory = true,description="Coefficient to multiply the dot product by.")
    private double gamma;

    @Config(mandatory = true,description="Scalar intercept to add to the dot product.")
    private double intercept;

    /**
     * For olcut.
     */
    private Sigmoid() {}

    /**
     * A sigmoid kernel, tanh(gamma*u.dot(v) + intercept).
     * @param gamma A scalar coefficient.
     * @param intercept An additive coefficient.
     */
    public Sigmoid(double gamma, double intercept) {
        this.gamma = gamma;
        this.intercept = intercept;
    }

    @Override
    public double similarity(SparseVector a, SparseVector b) {
        return Math.tanh(gamma * a.dot(b) + intercept);
    }

    @Override
    public String toString() {
        return "Sigmoid(gamma="+gamma+",intercept="+intercept+")";
    }

    @Override
    public ConfiguredObjectProvenance getProvenance() {
        return new ConfiguredObjectProvenanceImpl(this,"Kernel");
    }
}