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

Show more of this group Show more artifacts with this name
Show all versions of mindseye-research Show documentation
Experimental Optimizers and Neural Networks
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.opt.region;

import com.simiacryptus.lang.ref.RecycleBin;
import com.simiacryptus.util.ArrayUtil;

import javax.annotation.Nonnull;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.IntStream;

/**
 * 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 OrthonormalConstraint implements TrustRegion {

  private final int[][] indexMap;
  private boolean ortho = true;
  private boolean unit = true;

  /**
   * Instantiates a new Orthonormal constraint.
   *
   * @param indexMap the index map
   */
  public OrthonormalConstraint(int[]... indexMap) {
    if (Arrays.stream(indexMap).mapToInt(x -> x.length).distinct().count() != 1) {
      throw new AssertionError();
    }
    assert Arrays.stream(indexMap).flatMapToInt(x -> Arrays.stream(x)).distinct().count() == Arrays.stream(indexMap).flatMapToInt(x -> Arrays.stream(x)).count();
    assert Arrays.stream(indexMap).flatMapToInt(x -> Arrays.stream(x)).max().getAsInt() == Arrays.stream(indexMap).flatMapToInt(x -> Arrays.stream(x)).count() - 1;
    assert Arrays.stream(indexMap).flatMapToInt(x -> Arrays.stream(x)).min().getAsInt() == 0;
    this.indexMap = indexMap;
  }

  /**
   * Dot double.
   *
   * @param a the a
   * @param b the b
   * @return the double
   */
  public static double dot(double[] a, double[] b) {
    return IntStream.range(0, a.length).mapToDouble(i -> a[i] * b[i]).sum();
  }

  /**
   * Add double [ ].
   *
   * @param a the a
   * @param b the b
   * @return the double [ ]
   */
  public static double[] add(double[] a, double[] b) {
    return IntStream.range(0, a.length).mapToDouble(i -> a[i] + b[i]).toArray();
  }

  /**
   * Scale double [ ].
   *
   * @param a the a
   * @param b the b
   * @return the double [ ]
   */
  public static double[] scale(double[] a, double b) {
    return Arrays.stream(a).map(v -> v * b).toArray();
  }

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

  /**
   * Unit vectors list.
   *
   * @param vectors the vectors
   * @return the list
   */
  public List unitVectors(final List vectors) {
    double[] magnitudes = vectors.stream().mapToDouble(x -> Math.sqrt(Arrays.stream(x).map(a -> a * a).sum())).toArray();
    return IntStream.range(
        0,
        magnitudes.length
    ).mapToObj(n -> Arrays.stream(vectors.get(n)).map(x -> x / magnitudes[n]).toArray()).collect(Collectors.toList());
  }

  @Nonnull
  @Override
  public double[] project(@Nonnull final double[] weights, @Nonnull final double[] point) {
    List decompose = decompose(point);
    List orthogonal = isOrtho() ? orthogonal(decompose) : decompose;
    List unitVectors = isUnit() ? unitVectors(orthogonal) : orthogonal;
    return recompose(unitVectors);
  }

  /**
   * Orthogonal list.
   *
   * @param vectors the vectors
   * @return the list
   */
  public List orthogonal(final List vectors) {
    ArrayList result = new ArrayList<>();
    for (final double[] vector : vectors) {
      double[] orthogonalVector = scale(vector, 1);
      for (final double[] basisVector : result) {
        orthogonalVector = add(orthogonalVector, scale(basisVector, -dot(orthogonalVector, basisVector) / dot(basisVector, basisVector)));
      }
      result.add(orthogonalVector);
    }
    return result;
  }

  /**
   * Recompose double [ ].
   *
   * @param unitVectors the unit vectors
   * @return the double [ ]
   */
  public double[] recompose(final List unitVectors) {
    double[] doubles = RecycleBin.DOUBLES.create(Arrays.stream(indexMap).mapToInt(x -> x.length).sum());
    IntStream.range(0, indexMap.length).forEach(n -> {
      double[] array = unitVectors.get(n);
      IntStream.range(0, array.length).forEach(m -> {
        doubles[indexMap[n][m]] = unitVectors.get(n)[m];
      });
    });
    return doubles;
  }

  /**
   * Decompose list.
   *
   * @param point the point
   * @return the list
   */
  public List decompose(@Nonnull final double[] point) {
    return Arrays.stream(indexMap).map(x -> Arrays.stream(x).mapToDouble(i -> point[i]).toArray()).collect(Collectors.toList());
  }

  /**
   * Is ortho boolean.
   *
   * @return the boolean
   */
  public boolean isOrtho() {
    return ortho;
  }

  /**
   * Sets ortho.
   *
   * @param ortho the ortho
   * @return the ortho
   */
  public OrthonormalConstraint setOrtho(boolean ortho) {
    this.ortho = ortho;
    return this;
  }

  /**
   * Is unit boolean.
   *
   * @return the boolean
   */
  public boolean isUnit() {
    return unit;
  }

  /**
   * Sets unit.
   *
   * @param unit the unit
   * @return the unit
   */
  public OrthonormalConstraint setUnit(boolean unit) {
    this.unit = unit;
    return this;
  }
}