/*
 * 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.sysds.runtime.compress.CompressedMatrixBlock;
import org.apache.sysds.runtime.controlprogram.context.ExecutionContext;
import org.apache.sysds.runtime.instructions.InstructionUtils;
import org.apache.sysds.runtime.matrix.data.LibCommonsMath;
import org.apache.sysds.runtime.matrix.data.LibMatrixBincell;
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 final boolean inplace;

	protected BinaryMatrixMatrixCPInstruction(Operator op, CPOperand in1, CPOperand in2, CPOperand out, String opcode,
		String istr) {
		super(CPType.Binary, op, in1, in2, out, opcode, istr);
		if(op instanceof BinaryOperator) {
			final String[] parts = InstructionUtils.getInstructionParts(istr);
			if(parts.length == 5) {
				((BinaryOperator) op).setNumThreads(Integer.parseInt(parts[parts.length - 1]));
				inplace = false;
			}
			else {
				((BinaryOperator) op).setNumThreads(Integer.parseInt(parts[parts.length - 2]));
				if(parts[parts.length - 1].equals("InPlace"))
					inplace = true;
				else
					inplace = false;
			}
		}
		else
			inplace = false;
	}

	public boolean isInPlace() {
		return inplace;
	}

	@Override
	public void processInstruction(ExecutionContext ec) {
		// Read input matrices
		MatrixBlock inBlock1 = ec.getMatrixInput(input1.getName());
		MatrixBlock inBlock2 = ec.getMatrixInput(input2.getName());

		boolean compressedLeft = inBlock1 instanceof CompressedMatrixBlock;
		boolean compressedRight = inBlock2 instanceof CompressedMatrixBlock;

		MatrixBlock retBlock;

		if(inplace && (compressedLeft || compressedRight))
			LOG.error("Not supporting inplace compressed binary operations yet");

		if(inplace && !(compressedLeft || compressedRight)) {
			inBlock1 = LibMatrixBincell.bincellOpInPlace(inBlock1, inBlock2, (BinaryOperator) _optr);
			// Release the memory occupied by input matrices
			ec.releaseMatrixInput(input1.getName(), input2.getName());
			// Cleanup the inplace metadata input.
			ec.removeVariable(input1.getName());
			retBlock = inBlock1;
		}
		else {
			if(LibCommonsMath.isSupportedMatrixMatrixOperation(getOpcode()) ){
				if(compressedLeft)
					inBlock1 = CompressedMatrixBlock.getUncompressed(inBlock1, getOpcode());
				
				if(compressedRight)
					inBlock2 = CompressedMatrixBlock.getUncompressed(inBlock2, getOpcode());

				retBlock = LibCommonsMath.matrixMatrixOperations(inBlock1, inBlock2, getOpcode());
			}
			else {
				// Perform computation using input matrices, and produce the result matrix
				BinaryOperator bop = (BinaryOperator) _optr;
				if(!compressedLeft && compressedRight)
					retBlock = ((CompressedMatrixBlock) inBlock2).binaryOperationsLeft(bop, inBlock1, 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)){
				int k = (_optr instanceof BinaryOperator) ? ((BinaryOperator) _optr).getNumThreads() : 1; 
				retBlock.examSparsity(k);
			}
		}

		// Attach result matrix with MatrixObject associated with output_name
		ec.setMatrixOutput(output.getName(), retBlock);
	}
}
