org.apache.sysml.utils.LRUCacheMap Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of systemml Show documentation
Declarative Machine Learning
There is a newer version: 1.2.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF 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 org.apache.sysml.utils;


import org.apache.sysml.runtime.DMLRuntimeException;

import java.util.LinkedHashMap;
import java.util.Map;

/**
 * An access ordered LRU Cache Map which conforms to the {@link Map} interface
 * while also providing the ability to get the least recently used entry
 * @param  the key type
 * @param  the value type
 */
public class LRUCacheMap extends LinkedHashMap {

	private static final long serialVersionUID = 7078404374799241418L;

/**
   * Creates an access-ordered {@link LRUCacheMap}
   */
  public LRUCacheMap() {
    // An access-ordered LinkedHashMap is instantiated with the default initial capacity and load factors
    super(16, 0.75f, true);
  }

  // Private variables to assist in capturing the lease recently used entry
  private boolean evictLRU = false;
  private Map.Entry lastEvictedEntry = null;

  /**
   * Removes and gets the least recently used entry
   * @return  the lease recently used entry
   * @throws DMLRuntimeException if the internal state is somehow corrupted
   */
  public Map.Entry removeAndGetLRUEntry() throws DMLRuntimeException {
    lastEvictedEntry = null;
    if (size() <= 0){
      return null;
    }

    // The idea is to set removing the eldest entry to true and then putting in a dummy
    // entry (null, null). the removeEldestEntry will capture the eldest entry and is available
    // to return via a class member variable.
    evictLRU = true;
    V previous = super.put(null, null);
    remove(null);
    if (previous != null){
      throw new DMLRuntimeException("ERROR : Internal state of LRUCacheMap invalid - a value for the key 'null' is already present");
    }
    evictLRU = false;
    Map.Entry toRet = lastEvictedEntry;
    return toRet;
  }

  @Override
  protected boolean removeEldestEntry(Map.Entry eldest) {
    if (evictLRU) {
      lastEvictedEntry = eldest;
      return true;
    }
    return false;
  }

  @Override
  public V put (K k, V v){
    if (k == null)
      throw new IllegalArgumentException("ERROR: an entry with a null key was tried to be inserted in to the LRUCacheMap");
    return super.put (k, v);
  }


}