com.simiacryptus.mindseye.layers.java.BoundedActivationLayer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mindseye-java Show documentation
Pure Java Neural Networks Components
There is a newer version: 2.1.0
/*
 * Copyright (c) 2019 by Andrew Charneski.
 *
 * The author licenses this file to you 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.
 */

package com.simiacryptus.mindseye.layers.java;

import com.google.gson.JsonObject;
import com.simiacryptus.mindseye.lang.DataSerializer;

import javax.annotation.Nonnull;
import java.util.Map;

/**
 * Enforces a maximum-maxValue constraint on the input signal, rounding down any values exceeding a setByCoord threshold.
 */
@SuppressWarnings("serial")
public class BoundedActivationLayer extends SimpleActivationLayer {

  private double maxValue = Double.POSITIVE_INFINITY;
  private double minValue = Double.NEGATIVE_INFINITY;

  /**
   * Instantiates a new Max const key.
   */
  public BoundedActivationLayer() {
    super();
  }

  /**
   * Instantiates a new Max const key.
   *
   * @param id the id
   */
  protected BoundedActivationLayer(@Nonnull final JsonObject id) {
    super(id);
  }

  /**
   * From json max const key.
   *
   * @param json the json
   * @param rs   the rs
   * @return the max const key
   */
  @Nonnull
  public static BoundedActivationLayer fromJson(@Nonnull final JsonObject json, Map rs) {
    @Nonnull final BoundedActivationLayer obj = new BoundedActivationLayer(json);
    obj.maxValue = json.get("maxValue").getAsDouble();
    return obj;
  }

  @Override
  protected void eval(final double x, final double[] results) {
    final double d = x > maxValue || x < getMinValue() ? 0 : 1;
    final double f = x > maxValue ? maxValue : x < getMinValue() ? getMinValue() : x;
    assert Double.isFinite(d);
    results[0] = f;
    results[1] = d;
  }

  @Nonnull
  @Override
  public JsonObject getJson(Map resources, DataSerializer dataSerializer) {
    @Nonnull final JsonObject json = super.getJsonStub();
    json.addProperty("maxValue", maxValue);
    return json;
  }

  /**
   * Gets maxValue.
   *
   * @return the maxValue
   */
  public double getMaxValue() {
    return maxValue;
  }

  /**
   * Sets maxValue.
   *
   * @param maxValue the maxValue
   * @return the maxValue
   */
  @Nonnull
  public BoundedActivationLayer setMaxValue(final double maxValue) {
    this.maxValue = maxValue;
    return this;
  }

  public double getMinValue() {
    return minValue;
  }

  public BoundedActivationLayer setMinValue(double minValue) {
    this.minValue = minValue;
    return this;
  }
}