src/main/java/org/apache/sysds/runtime/instructions/cp/BinaryMatrixMatrixCPInstruction.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.sysds.runtime.instructions.cp;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.sysds.runtime.compress.AbstractCompressedMatrixBlock;
import org.apache.sysds.runtime.compress.CompressedMatrixBlock;
import org.apache.sysds.runtime.controlprogram.context.ExecutionContext;
import org.apache.sysds.runtime.matrix.data.LibCommonsMath;
import org.apache.sysds.runtime.matrix.data.MatrixBlock;
import org.apache.sysds.runtime.matrix.operators.BinaryOperator;
import org.apache.sysds.runtime.matrix.operators.Operator;

public class BinaryMatrixMatrixCPInstruction extends BinaryCPInstruction {
	private static final Log LOG = LogFactory.getLog(BinaryMatrixMatrixCPInstruction.class.getName());

	protected BinaryMatrixMatrixCPInstruction(Operator op, CPOperand in1, CPOperand in2, CPOperand out,
			String opcode, String istr) {
		super(CPType.Binary, op, in1, in2, out, opcode, istr);
	}

	@Override
	public void processInstruction(ExecutionContext ec) {
		if ( LibCommonsMath.isSupportedMatrixMatrixOperation(getOpcode()) ) {
			MatrixBlock solution = LibCommonsMath.matrixMatrixOperations(
				ec.getMatrixInput(input1.getName()), ec.getMatrixInput(input2.getName()), getOpcode());
			ec.setMatrixOutput(output.getName(), solution);
			ec.releaseMatrixInput(input1.getName());
			ec.releaseMatrixInput(input2.getName());
			
			return;
		}
		
		// Read input matrices
		MatrixBlock inBlock1 = ec.getMatrixInput(input1.getName());
		MatrixBlock inBlock2 = ec.getMatrixInput(input2.getName());

		// Perform computation using input matrices, and produce the result matrix
		BinaryOperator bop = (BinaryOperator) _optr;
		MatrixBlock retBlock;

		if(inBlock1 instanceof CompressedMatrixBlock && inBlock2 instanceof CompressedMatrixBlock){
			retBlock = inBlock1.binaryOperations(bop, inBlock2, new MatrixBlock());
		} else if(inBlock2 instanceof CompressedMatrixBlock){
			LOG.error("Binary CP instruction decompressing " + bop);
			LOG.error("inBlock2 stats: " + inBlock2.getNumRows() + "  " +inBlock2.getNumColumns());
			inBlock2 = AbstractCompressedMatrixBlock.getUncompressed(inBlock2);
			retBlock = inBlock1.binaryOperations(bop, inBlock2, new MatrixBlock());
		} else {
			retBlock = inBlock1.binaryOperations(bop, inBlock2, new MatrixBlock());
		}
		
		// Release the memory occupied by input matrices
		ec.releaseMatrixInput(input1.getName(), input2.getName());
		
		// Ensure right dense/sparse output representation (guarded by released input memory)
		if( checkGuardedRepresentationChange(inBlock1, inBlock2, retBlock) ) {
			retBlock.examSparsity();
		}
		
		// Attach result matrix with MatrixObject associated with output_name
		ec.setMatrixOutput(output.getName(), retBlock);
	}
}