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

Go to download

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.mindseye.lang.Layer;
import com.simiacryptus.mindseye.opt.orient.TrustRegionStrategy;

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

/**
 * A concrete class of the TrustRegion orientation strategy base class, this uses a buildMap collection to store per-key
 * Trust Region configurations.
 */
public class LayerTrustRegionMap extends TrustRegionStrategy {
  @Nonnull
  private final Map regionPolicies = new HashMap<>();
  @Nullable
  private TrustRegion defaultRegionPolicy = null;

  /**
   * Gets default region policy.
   *
   * @return the default region policy
   */
  @Nullable
  public TrustRegion getDefaultRegionPolicy() {
    return defaultRegionPolicy;
  }

  /**
   * Gets region policies.
   *
   * @return the region policies
   */
  @Nonnull
  public Map getRegionPolicies() {
    return regionPolicies;
  }

  @Override
  public TrustRegion getRegionPolicy(final Layer layer) {
    return regionPolicies.getOrDefault(layer, defaultRegionPolicy);
  }

  @Override
  public void reset() {
    inner.reset();
  }

  /**
   * Sets default region policy.
   *
   * @param defaultRegionPolicy the default region policy
   * @return the default region policy
   */
  @Nonnull
  public TrustRegionStrategy setDefaultRegionPolicy(final TrustRegion defaultRegionPolicy) {
    this.defaultRegionPolicy = defaultRegionPolicy;
    return this;
  }
}