com.simiacryptus.mindseye.opt.region.RangeConstraint Maven / Gradle / Ivy

Go to download
/*
 * 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.opt.region;

import com.simiacryptus.util.ArrayUtil;

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

/**
 * This constraint ensures that the L2 magnitude of the weight evalInputDelta cannot exceed a simple threshold. A simpler version
 * of AdaptiveTrustSphere, it places a limit on the step size for a given key.
 */
public class RangeConstraint implements TrustRegion {

  private double min;
  private double max;

  /**
   * Instantiates a new Range constraint.
   */
  public RangeConstraint() {
    min = 0;
    max = 255;
  }

  /**
   * Instantiates a new Range constraint.
   *
   * @param min the min
   * @param max the max
   */
  public RangeConstraint(final double min, final double max) {
    this.min = min;
    this.max = max;
  }

  /**
   * Gets max.
   *
   * @return the max
   */
  public double getMax() {
    return max;
  }

  /**
   * Sets max.
   *
   * @param max the max
   * @return the max
   */
  @Nonnull
  public RangeConstraint setMax(final double max) {
    this.max = max;
    return this;
  }

  /**
   * Length double.
   *
   * @param weights the weights
   * @return the double
   */
  public double length(@Nonnull final double[] weights) {
    return ArrayUtil.magnitude(weights);
  }

  @Nonnull
  @Override
  public double[] project(@Nonnull final double[] weights, @Nonnull final double[] point) {
    return Arrays.stream(point).map(x -> Math.max(x, min)).map(x -> Math.min(x, max)).toArray();
  }

  /**
   * Gets min.
   *
   * @return the min
   */
  public double getMin() {
    return min;
  }

  /**
   * Sets min.
   *
   * @param min the min
   * @return the min
   */
  public RangeConstraint setMin(double min) {
    this.min = min;
    return this;
  }
}