KeyMapper.java

/*
 * 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.ignite.ml.math;

import java.io.Serializable;

/**
 * Maps key objects to index in {@link Vector} or {@link Matrix}.
 */
public interface KeyMapper<K> extends Serializable {
    /**
     * Checks given cache key corresponds to a valid index in vector or matrix.
     *
     * @param k Key to check.
     * @return {@code true} if there is a valid index, {@code false} otherwise.
     */
    public boolean isValid(K k);
}