IDistributedCacheConsumer.java example

Explorer
systemml-master
- system-ml
  - src
/**
 * (C) Copyright IBM Corp. 2010, 2015
 *
 * Licensed 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.ibm.bi.dml.runtime.instructions.mr;

import java.util.ArrayList;

/**
 * This interface generalized the compiler/runtime interactions with instructions 
 * that consume inputs from distributed cache. 
 * 
 */
public interface IDistributedCacheConsumer 
{
	/**
	 * Determines if given index is only used via distributed cache. 
	 * 
	 * @param inst
	 * @param index
	 * @return
	 */
	public boolean isDistCacheOnlyIndex( String inst, byte index );
	
	/**
	 * Adds all indexes that are used via distributed cache to the output. 
	 * 
	 * @param inst
	 * @param indexes
	 */
	public void addDistCacheIndex( String inst, ArrayList<Byte> indexes );
}