org.nd4j.linalg.compression.AbstractStorage Maven / Gradle / Ivy
/*******************************************************************************
* Copyright (c) 2015-2018 Skymind, Inc.
*
* This program and the accompanying materials are made available under the
* terms of the Apache License, Version 2.0 which is available at
* https://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.
*
* SPDX-License-Identifier: Apache-2.0
******************************************************************************/
package org.nd4j.linalg.compression;
import org.nd4j.linalg.api.ndarray.INDArray;
/**
* This interface describes basic Key-Value storage, where Key is any object, and Value is INDArray located "somewhere else"
*
*
* @author [email protected]
*/
public interface AbstractStorage {
/**
* Store object into storage
*
* @param key
* @param object
*/
void store(T key, INDArray object);
/**
* Store object into storage
*
* @param key
* @param array
*/
void store(T key, float[] array);
/**
* Store object into storage
*
* @param key
* @param array
*/
void store(T key, double[] array);
/**
* Store object into storage, if it doesn't exist
* @param key
* @param object
*/
boolean storeIfAbsent(T key, INDArray object);
/**
* Get object from the storage, by key
*
* @param key
*/
INDArray get(T key);
/**
* This method checks, if storage contains specified key
*
* @param key
* @return
*/
boolean containsKey(T key);
/**
* This method purges everything from storage
*/
void clear();
/**
* This method removes value by specified key
*/
void drop(T key);
/**
* This method returns number of entries available in storage
*/
long size();
}