org.apache.sysml.lops.FunctionCallCP Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of systemml Show documentation
Show all versions of systemml Show documentation
Declarative Machine Learning
/*
* 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.sysml.lops;
import java.util.ArrayList;
import org.apache.sysml.hops.FunctionOp;
import org.apache.sysml.hops.Hop;
import org.apache.sysml.hops.HopsException;
import org.apache.sysml.lops.LopProperties.ExecLocation;
import org.apache.sysml.lops.LopProperties.ExecType;
import org.apache.sysml.lops.compile.JobType;
import org.apache.sysml.parser.DMLProgram;
import org.apache.sysml.parser.Expression.DataType;
import org.apache.sysml.parser.Expression.ValueType;
public class FunctionCallCP extends Lop
{
private String _fnamespace;
private String _fname;
private String[] _outputs;
private ArrayList _outputLops = null;
public FunctionCallCP(ArrayList inputs, String fnamespace, String fname, String[] outputs, ArrayList outputHops, ExecType et)
throws HopsException, LopsException
{
this(inputs, fnamespace, fname, outputs, et);
if(outputHops != null) {
_outputLops = new ArrayList();
for(Hop h : outputHops)
_outputLops.add( h.constructLops() );
}
}
public FunctionCallCP(ArrayList inputs, String fnamespace, String fname, String[] outputs, ExecType et)
{
super(Lop.Type.FunctionCallCP, DataType.UNKNOWN, ValueType.UNKNOWN);
//note: data scalar in order to prevent generation of redundant createvar, rmvar
_fnamespace = fnamespace;
_fname = fname;
_outputs = outputs;
//wire inputs
for( Lop in : inputs ) {
addInput( in );
in.addOutput( this );
}
//lop properties: always in CP
boolean breaksAlignment = false;
boolean aligner = false;
boolean definesMRJob = false;
lps.addCompatibility(JobType.INVALID);
lps.setProperties(inputs, et, ExecLocation.ControlProgram, breaksAlignment, aligner, definesMRJob );
}
public ArrayList getFunctionOutputs() {
return _outputLops;
}
@Override
public String toString() {
return "function call: " + DMLProgram.constructFunctionKey(_fnamespace, _fname);
}
private String getInstructionsMultipleReturnBuiltins(String[] inputs, String[] outputs) {
StringBuilder sb = new StringBuilder();
sb.append(getExecType());
sb.append(Lop.OPERAND_DELIMITOR);
sb.append(_fname.toLowerCase());
for(int i=0; i< inputs.length; i++) {
sb.append(Lop.OPERAND_DELIMITOR);
sb.append( getInputs().get(i).prepInputOperand(inputs[i]) );
}
for(int i=0; i< _outputs.length; i++) {
sb.append(Lop.OPERAND_DELIMITOR);
sb.append(_outputs[i]);
}
return sb.toString();
}
/**
* Method to generate instructions for external functions as well as builtin functions with multiple returns.
* Builtin functions have their namespace set to DMLProgram.INTERNAL_NAMESPACE ("_internal").
*/
@Override
public String getInstructions(String[] inputs, String[] outputs) throws LopsException
{
// Handle internal builtin functions
if (_fnamespace.equalsIgnoreCase(DMLProgram.INTERNAL_NAMESPACE) ) {
return getInstructionsMultipleReturnBuiltins(inputs, outputs);
}
//Instruction format extFunct:::[FUNCTION NAMESPACE]:::[FUNCTION NAME]:::[num input params]:::[num output params]:::[list of delimited input params ]:::[list of delimited ouput params]
//These are the "bound names" for the inputs / outputs. For example, out1 = ns::foo(in1, in2) yields
//extFunct:::ns:::foo:::2:::1:::in1:::in2:::out1
//NOTE: we have to append full input operand information to distinguish literals from variables w/ equal name
StringBuilder inst = new StringBuilder();
inst.append(getExecType());
inst.append(Lop.OPERAND_DELIMITOR);
inst.append(FunctionOp.OPSTRING);
inst.append(Lop.OPERAND_DELIMITOR);
inst.append(_fnamespace);
inst.append(Lop.OPERAND_DELIMITOR);
inst.append(_fname);
inst.append(Lop.OPERAND_DELIMITOR);
inst.append(inputs.length);
inst.append(Lop.OPERAND_DELIMITOR);
inst.append(_outputs.length);
for(int i=0; i