Package org.apache.sysds.common
Enum Builtins
- java.lang.Object
- 
- java.lang.Enum<Builtins>
- 
- org.apache.sysds.common.Builtins
 
 
- 
- All Implemented Interfaces:
- Serializable,- Comparable<Builtins>
 
 public enum Builtins extends Enum<Builtins> Enum to represent all builtin functions in the default name space. Each function is either native or implemented by a DML script. In case of DML script, these functions are loaded during parsing. As always, user-defined DML-bodied functions take precedence over all builtin functions. To add a new builtin script function, simply add the definition here as well as a dml file in scripts/builtin with a matching name. On building SystemDS, these scripts are packaged into the jar as well.
- 
- 
Enum Constant Summary
 - 
Method SummaryAll Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static booleancontains(String name, boolean script, boolean parameterized)static Builtinsget(String name)static Builtinsget(String name, boolean params)StringgetAlias()static StringgetFilePath(String name)static StringgetInternalFName(String name, Types.DataType dt)StringgetName()booleanisMultiReturn()booleanisParameterized()booleanisScript()static BuiltinsvalueOf(String name)Returns the enum constant of this type with the specified name.static Builtins[]values()Returns an array containing the constants of this enum type, in the order they are declared.
 
- 
- 
- 
Enum Constant Detail- 
ABSTAINpublic static final Builtins ABSTAIN 
 - 
ABSpublic static final Builtins ABS 
 - 
ACOSpublic static final Builtins ACOS 
 - 
ALSpublic static final Builtins ALS 
 - 
ALS_CGpublic static final Builtins ALS_CG 
 - 
ALS_DSpublic static final Builtins ALS_DS 
 - 
ALS_PREDICTpublic static final Builtins ALS_PREDICT 
 - 
ALS_TOPK_PREDICTpublic static final Builtins ALS_TOPK_PREDICT 
 - 
APPLY_PIPELINEpublic static final Builtins APPLY_PIPELINE 
 - 
ARIMApublic static final Builtins ARIMA 
 - 
ASINpublic static final Builtins ASIN 
 - 
ATANpublic static final Builtins ATAN 
 - 
AUTOENCODER2LAYERpublic static final Builtins AUTOENCODER2LAYER 
 - 
AVG_POOLpublic static final Builtins AVG_POOL 
 - 
AVG_POOL_BACKWARDpublic static final Builtins AVG_POOL_BACKWARD 
 - 
BATCH_NORM2Dpublic static final Builtins BATCH_NORM2D 
 - 
BATCH_NORM2D_BACKWARDpublic static final Builtins BATCH_NORM2D_BACKWARD 
 - 
BIASADDpublic static final Builtins BIASADD 
 - 
BIASMULTpublic static final Builtins BIASMULT 
 - 
BANDITpublic static final Builtins BANDIT 
 - 
BITWANDpublic static final Builtins BITWAND 
 - 
BITWORpublic static final Builtins BITWOR 
 - 
BITWXORpublic static final Builtins BITWXOR 
 - 
BITWSHIFTLpublic static final Builtins BITWSHIFTL 
 - 
BITWSHIFTRpublic static final Builtins BITWSHIFTR 
 - 
BIVARpublic static final Builtins BIVAR 
 - 
CAST_AS_BOOLEANpublic static final Builtins CAST_AS_BOOLEAN 
 - 
CAST_AS_DOUBLEpublic static final Builtins CAST_AS_DOUBLE 
 - 
CAST_AS_FRAMEpublic static final Builtins CAST_AS_FRAME 
 - 
CAST_AS_INTpublic static final Builtins CAST_AS_INT 
 - 
CAST_AS_LISTpublic static final Builtins CAST_AS_LIST 
 - 
CAST_AS_MATRIXpublic static final Builtins CAST_AS_MATRIX 
 - 
CAST_AS_SCALARpublic static final Builtins CAST_AS_SCALAR 
 - 
CBINDpublic static final Builtins CBIND 
 - 
CEILpublic static final Builtins CEIL 
 - 
CHOLESKYpublic static final Builtins CHOLESKY 
 - 
COLMAXpublic static final Builtins COLMAX 
 - 
COLMEANpublic static final Builtins COLMEAN 
 - 
COLMINpublic static final Builtins COLMIN 
 - 
COLNAMESpublic static final Builtins COLNAMES 
 - 
COLPRODpublic static final Builtins COLPROD 
 - 
COLSDpublic static final Builtins COLSD 
 - 
COLSUMpublic static final Builtins COLSUM 
 - 
COLVARpublic static final Builtins COLVAR 
 - 
COMPONENTSpublic static final Builtins COMPONENTS 
 - 
COMPRESSpublic static final Builtins COMPRESS 
 - 
CONFUSIONMATRIXpublic static final Builtins CONFUSIONMATRIX 
 - 
CONV2Dpublic static final Builtins CONV2D 
 - 
CONV2D_BACKWARD_FILTERpublic static final Builtins CONV2D_BACKWARD_FILTER 
 - 
CONV2D_BACKWARD_DATApublic static final Builtins CONV2D_BACKWARD_DATA 
 - 
CORpublic static final Builtins COR 
 - 
CORRECTTYPOSpublic static final Builtins CORRECTTYPOS 
 - 
CORRECTTYPOSAPPLYpublic static final Builtins CORRECTTYPOSAPPLY 
 - 
COSpublic static final Builtins COS 
 - 
COSHpublic static final Builtins COSH 
 - 
COUNT_DISTINCTpublic static final Builtins COUNT_DISTINCT 
 - 
COVpublic static final Builtins COV 
 - 
COXpublic static final Builtins COX 
 - 
CSPLINEpublic static final Builtins CSPLINE 
 - 
CSPLINE_CGpublic static final Builtins CSPLINE_CG 
 - 
CSPLINE_DSpublic static final Builtins CSPLINE_DS 
 - 
CUMMAXpublic static final Builtins CUMMAX 
 - 
CUMMINpublic static final Builtins CUMMIN 
 - 
CUMPRODpublic static final Builtins CUMPROD 
 - 
CUMSUMpublic static final Builtins CUMSUM 
 - 
CUMSUMPRODpublic static final Builtins CUMSUMPROD 
 - 
DBSCANpublic static final Builtins DBSCAN 
 - 
DBSCANAPPLYpublic static final Builtins DBSCANAPPLY 
 - 
DECISIONTREEpublic static final Builtins DECISIONTREE 
 - 
DECISIONTREEPREDICTpublic static final Builtins DECISIONTREEPREDICT 
 - 
DECOMPRESSpublic static final Builtins DECOMPRESS 
 - 
DEEPWALKpublic static final Builtins DEEPWALK 
 - 
DETECTSCHEMApublic static final Builtins DETECTSCHEMA 
 - 
DENIALCONSTRAINTSpublic static final Builtins DENIALCONSTRAINTS 
 - 
DIAGpublic static final Builtins DIAG 
 - 
DISCOVER_FDpublic static final Builtins DISCOVER_FD 
 - 
DISCOVER_MDpublic static final Builtins DISCOVER_MD 
 - 
SETDIFFpublic static final Builtins SETDIFF 
 - 
DISTpublic static final Builtins DIST 
 - 
DMVpublic static final Builtins DMV 
 - 
DROP_INVALID_TYPEpublic static final Builtins DROP_INVALID_TYPE 
 - 
DROP_INVALID_LENGTHpublic static final Builtins DROP_INVALID_LENGTH 
 - 
EIGENpublic static final Builtins EIGEN 
 - 
EMApublic static final Builtins EMA 
 - 
EXISTSpublic static final Builtins EXISTS 
 - 
EXECUTE_PIPELINEpublic static final Builtins EXECUTE_PIPELINE 
 - 
EXPpublic static final Builtins EXP 
 - 
EVALpublic static final Builtins EVAL 
 - 
EVALLISTpublic static final Builtins EVALLIST 
 - 
FIT_PIPELINEpublic static final Builtins FIT_PIPELINE 
 - 
FIX_INVALID_LENGTHSpublic static final Builtins FIX_INVALID_LENGTHS 
 - 
FIX_INVALID_LENGTHS_APPLYpublic static final Builtins FIX_INVALID_LENGTHS_APPLY 
 - 
FF_TRAINpublic static final Builtins FF_TRAIN 
 - 
FF_PREDICTpublic static final Builtins FF_PREDICT 
 - 
FLOORpublic static final Builtins FLOOR 
 - 
FRAME_SORTpublic static final Builtins FRAME_SORT 
 - 
FRAME_ROW_REPLICATEpublic static final Builtins FRAME_ROW_REPLICATE 
 - 
FREQUENCYENCODEpublic static final Builtins FREQUENCYENCODE 
 - 
FREQUENCYENCODEAPPLYpublic static final Builtins FREQUENCYENCODEAPPLY 
 - 
GARCHpublic static final Builtins GARCH 
 - 
GAUSSIAN_CLASSIFIERpublic static final Builtins GAUSSIAN_CLASSIFIER 
 - 
GET_ACCURACYpublic static final Builtins GET_ACCURACY 
 - 
GLMpublic static final Builtins GLM 
 - 
GLM_PREDICTpublic static final Builtins GLM_PREDICT 
 - 
GMMpublic static final Builtins GMM 
 - 
GMM_PREDICTpublic static final Builtins GMM_PREDICT 
 - 
GNMFpublic static final Builtins GNMF 
 - 
GRID_SEARCHpublic static final Builtins GRID_SEARCH 
 - 
TOPK_CLEANINGpublic static final Builtins TOPK_CLEANING 
 - 
HOSPITAL_RESIDENCY_MATCHpublic static final Builtins HOSPITAL_RESIDENCY_MATCH 
 - 
HYPERBANDpublic static final Builtins HYPERBAND 
 - 
IFELSEpublic static final Builtins IFELSE 
 - 
IMG_MIRRORpublic static final Builtins IMG_MIRROR 
 - 
IMG_BRIGHTNESSpublic static final Builtins IMG_BRIGHTNESS 
 - 
IMG_CROPpublic static final Builtins IMG_CROP 
 - 
IMG_TRANSFORMpublic static final Builtins IMG_TRANSFORM 
 - 
IMG_TRANSLATEpublic static final Builtins IMG_TRANSLATE 
 - 
IMG_ROTATEpublic static final Builtins IMG_ROTATE 
 - 
IMG_SHEARpublic static final Builtins IMG_SHEAR 
 - 
IMG_CUTOUTpublic static final Builtins IMG_CUTOUT 
 - 
IMG_SAMPLE_PAIRINGpublic static final Builtins IMG_SAMPLE_PAIRING 
 - 
IMG_INVERTpublic static final Builtins IMG_INVERT 
 - 
IMG_POSTERIZEpublic static final Builtins IMG_POSTERIZE 
 - 
IMPURITY_MEASURESpublic static final Builtins IMPURITY_MEASURES 
 - 
IMPUTE_BY_MEANpublic static final Builtins IMPUTE_BY_MEAN 
 - 
IMPUTE_BY_MEAN_APPLYpublic static final Builtins IMPUTE_BY_MEAN_APPLY 
 - 
IMPUTE_BY_MEDIANpublic static final Builtins IMPUTE_BY_MEDIAN 
 - 
IMPUTE_BY_MEDIAN_APPLYpublic static final Builtins IMPUTE_BY_MEDIAN_APPLY 
 - 
IMPUTE_BY_MODEpublic static final Builtins IMPUTE_BY_MODE 
 - 
IMPUTE_BY_MODE_APPLYpublic static final Builtins IMPUTE_BY_MODE_APPLY 
 - 
IMPUTE_FDpublic static final Builtins IMPUTE_FD 
 - 
IMPUTE_FD_APPLYpublic static final Builtins IMPUTE_FD_APPLY 
 - 
INTERQUANTILEpublic static final Builtins INTERQUANTILE 
 - 
INTERSECTpublic static final Builtins INTERSECT 
 - 
INVERSEpublic static final Builtins INVERSE 
 - 
IQMpublic static final Builtins IQM 
 - 
ISNApublic static final Builtins ISNA 
 - 
ISNANpublic static final Builtins ISNAN 
 - 
ISINFpublic static final Builtins ISINF 
 - 
KMpublic static final Builtins KM 
 - 
KMEANSpublic static final Builtins KMEANS 
 - 
KMEANSPREDICTpublic static final Builtins KMEANSPREDICT 
 - 
KNNBFpublic static final Builtins KNNBF 
 - 
KNNGRAPHpublic static final Builtins KNNGRAPH 
 - 
KNNpublic static final Builtins KNN 
 - 
L2SVMpublic static final Builtins L2SVM 
 - 
L2SVMPREDICTpublic static final Builtins L2SVMPREDICT 
 - 
LASSOpublic static final Builtins LASSO 
 - 
LENET_TRAINpublic static final Builtins LENET_TRAIN 
 - 
LENET_PREDICTpublic static final Builtins LENET_PREDICT 
 - 
LENGTHpublic static final Builtins LENGTH 
 - 
LINEAGEpublic static final Builtins LINEAGE 
 - 
LISTpublic static final Builtins LIST 
 - 
LMpublic static final Builtins LM 
 - 
LMCGpublic static final Builtins LMCG 
 - 
LMDSpublic static final Builtins LMDS 
 - 
LMPREDICTpublic static final Builtins LMPREDICT 
 - 
LOCALpublic static final Builtins LOCAL 
 - 
LOGpublic static final Builtins LOG 
 - 
LOGSUMEXPpublic static final Builtins LOGSUMEXP 
 - 
LSTMpublic static final Builtins LSTM 
 - 
LSTM_BACKWARDpublic static final Builtins LSTM_BACKWARD 
 - 
LUpublic static final Builtins LU 
 - 
MAPpublic static final Builtins MAP 
 - 
MATRIXPROFILEpublic static final Builtins MATRIXPROFILE 
 - 
MAXpublic static final Builtins MAX 
 - 
MAX_POOLpublic static final Builtins MAX_POOL 
 - 
MAX_POOL_BACKWARDpublic static final Builtins MAX_POOL_BACKWARD 
 - 
MCCpublic static final Builtins MCC 
 - 
MEANpublic static final Builtins MEAN 
 - 
MEDIANpublic static final Builtins MEDIAN 
 - 
MICEpublic static final Builtins MICE 
 - 
MICE_APPLYpublic static final Builtins MICE_APPLY 
 - 
MINpublic static final Builtins MIN 
 - 
MOMENTpublic static final Builtins MOMENT 
 - 
MSVMpublic static final Builtins MSVM 
 - 
MSVMPREDICTpublic static final Builtins MSVMPREDICT 
 - 
MULTILOGREGpublic static final Builtins MULTILOGREG 
 - 
MULTILOGREGPREDICTpublic static final Builtins MULTILOGREGPREDICT 
 - 
NA_LOCFpublic static final Builtins NA_LOCF 
 - 
NAIVEBAYESpublic static final Builtins NAIVEBAYES 
 - 
NAIVEBAYESPREDICTpublic static final Builtins NAIVEBAYESPREDICT 
 - 
NCOLpublic static final Builtins NCOL 
 - 
NORMALIZEpublic static final Builtins NORMALIZE 
 - 
NORMALIZEAPPLYpublic static final Builtins NORMALIZEAPPLY 
 - 
NROWpublic static final Builtins NROW 
 - 
OUTERpublic static final Builtins OUTER 
 - 
OUTLIERpublic static final Builtins OUTLIER 
 - 
OUTLIER_ARIMApublic static final Builtins OUTLIER_ARIMA 
 - 
OUTLIER_IQRpublic static final Builtins OUTLIER_IQR 
 - 
OUTLIER_IQR_APPLYpublic static final Builtins OUTLIER_IQR_APPLY 
 - 
OUTLIER_SDpublic static final Builtins OUTLIER_SD 
 - 
OUTLIER_SD_APPLYpublic static final Builtins OUTLIER_SD_APPLY 
 - 
PCApublic static final Builtins PCA 
 - 
PCAINVERSEpublic static final Builtins PCAINVERSE 
 - 
PCATRANSFORMpublic static final Builtins PCATRANSFORM 
 - 
PNMFpublic static final Builtins PNMF 
 - 
PPCApublic static final Builtins PPCA 
 - 
PPREDpublic static final Builtins PPRED 
 - 
PRODpublic static final Builtins PROD 
 - 
QRpublic static final Builtins QR 
 - 
QUANTILEpublic static final Builtins QUANTILE 
 - 
RANDOM_FORESTpublic static final Builtins RANDOM_FOREST 
 - 
RANGEpublic static final Builtins RANGE 
 - 
RBINDpublic static final Builtins RBIND 
 - 
REMOVEpublic static final Builtins REMOVE 
 - 
REVpublic static final Builtins REV 
 - 
ROUNDpublic static final Builtins ROUND 
 - 
ROWINDEXMAXpublic static final Builtins ROWINDEXMAX 
 - 
ROWINDEXMINpublic static final Builtins ROWINDEXMIN 
 - 
ROWMAXpublic static final Builtins ROWMAX 
 - 
ROWMEANpublic static final Builtins ROWMEAN 
 - 
ROWMINpublic static final Builtins ROWMIN 
 - 
ROWPRODpublic static final Builtins ROWPROD 
 - 
ROWSDpublic static final Builtins ROWSD 
 - 
ROWSUMpublic static final Builtins ROWSUM 
 - 
ROWVARpublic static final Builtins ROWVAR 
 - 
SAMPLEpublic static final Builtins SAMPLE 
 - 
SDpublic static final Builtins SD 
 - 
SELVARTHRESHpublic static final Builtins SELVARTHRESH 
 - 
SEQpublic static final Builtins SEQ 
 - 
SYMMETRICDIFFERENCEpublic static final Builtins SYMMETRICDIFFERENCE 
 - 
SHERLOCKpublic static final Builtins SHERLOCK 
 - 
SHERLOCKPREDICTpublic static final Builtins SHERLOCKPREDICT 
 - 
SHORTESTPATHpublic static final Builtins SHORTESTPATH 
 - 
SIGMOIDpublic static final Builtins SIGMOID 
 - 
SIGNpublic static final Builtins SIGN 
 - 
SINpublic static final Builtins SIN 
 - 
SINHpublic static final Builtins SINH 
 - 
SLICEFINDERpublic static final Builtins SLICEFINDER 
 - 
SMOTEpublic static final Builtins SMOTE 
 - 
SOFTMAXpublic static final Builtins SOFTMAX 
 - 
SOLVEpublic static final Builtins SOLVE 
 - 
SPLITpublic static final Builtins SPLIT 
 - 
SPLIT_BALANCEDpublic static final Builtins SPLIT_BALANCED 
 - 
STABLE_MARRIAGEpublic static final Builtins STABLE_MARRIAGE 
 - 
STATSNApublic static final Builtins STATSNA 
 - 
STRATSTATSpublic static final Builtins STRATSTATS 
 - 
STEPLMpublic static final Builtins STEPLM 
 - 
SQRTpublic static final Builtins SQRT 
 - 
SUMpublic static final Builtins SUM 
 - 
SVDpublic static final Builtins SVD 
 - 
TABLEpublic static final Builtins TABLE 
 - 
TANpublic static final Builtins TAN 
 - 
TANHpublic static final Builtins TANH 
 - 
TO_ONE_HOTpublic static final Builtins TO_ONE_HOT 
 - 
TOMEKLINKpublic static final Builtins TOMEKLINK 
 - 
TRACEpublic static final Builtins TRACE 
 - 
TRANSpublic static final Builtins TRANS 
 - 
TSNEpublic static final Builtins TSNE 
 - 
TYPEOFpublic static final Builtins TYPEOF 
 - 
UNIQUEpublic static final Builtins UNIQUE 
 - 
UNIVARpublic static final Builtins UNIVAR 
 - 
UNIONpublic static final Builtins UNION 
 - 
VARpublic static final Builtins VAR 
 - 
VALUE_SWAPpublic static final Builtins VALUE_SWAP 
 - 
VECTOR_TO_CSVpublic static final Builtins VECTOR_TO_CSV 
 - 
WINSORIZEpublic static final Builtins WINSORIZE 
 - 
WINSORIZEAPPLYpublic static final Builtins WINSORIZEAPPLY 
 - 
WOEpublic static final Builtins WOE 
 - 
WOEAPPLYpublic static final Builtins WOEAPPLY 
 - 
XGBOOSTpublic static final Builtins XGBOOST 
 - 
XGBOOSTPREDICTpublic static final Builtins XGBOOSTPREDICT 
 - 
XGBOOSTPREDICT_REGpublic static final Builtins XGBOOSTPREDICT_REG 
 - 
XGBOOSTPREDICT_CLASSpublic static final Builtins XGBOOSTPREDICT_CLASS 
 - 
XORpublic static final Builtins XOR 
 - 
AUTODIFFpublic static final Builtins AUTODIFF 
 - 
CDFpublic static final Builtins CDF 
 - 
COUNT_DISTINCT_APPROXpublic static final Builtins COUNT_DISTINCT_APPROX 
 - 
CVLMpublic static final Builtins CVLM 
 - 
GROUPEDAGGpublic static final Builtins GROUPEDAGG 
 - 
INVCDFpublic static final Builtins INVCDF 
 - 
LISTNVpublic static final Builtins LISTNV 
 - 
LOWER_TRIpublic static final Builtins LOWER_TRI 
 - 
ORDERpublic static final Builtins ORDER 
 - 
PARAMSERVpublic static final Builtins PARAMSERV 
 - 
PCHISQpublic static final Builtins PCHISQ 
 - 
PEXPpublic static final Builtins PEXP 
 - 
PFpublic static final Builtins PF 
 - 
PNORMpublic static final Builtins PNORM 
 - 
PTpublic static final Builtins PT 
 - 
QCHISQpublic static final Builtins QCHISQ 
 - 
QEXPpublic static final Builtins QEXP 
 - 
QFpublic static final Builtins QF 
 - 
QNORMpublic static final Builtins QNORM 
 - 
QTpublic static final Builtins QT 
 - 
REPLACEpublic static final Builtins REPLACE 
 - 
RMEMPTYpublic static final Builtins RMEMPTY 
 - 
SCALEpublic static final Builtins SCALE 
 - 
SCALEAPPLYpublic static final Builtins SCALEAPPLY 
 - 
SCALE_MINMAXpublic static final Builtins SCALE_MINMAX 
 - 
TIMEpublic static final Builtins TIME 
 - 
TOKENIZEpublic static final Builtins TOKENIZE 
 - 
TOSTRINGpublic static final Builtins TOSTRING 
 - 
TRANSFORMAPPLYpublic static final Builtins TRANSFORMAPPLY 
 - 
TRANSFORMCOLMAPpublic static final Builtins TRANSFORMCOLMAP 
 - 
TRANSFORMDECODEpublic static final Builtins TRANSFORMDECODE 
 - 
TRANSFORMENCODEpublic static final Builtins TRANSFORMENCODE 
 - 
TRANSFORMMETApublic static final Builtins TRANSFORMMETA 
 - 
UNDER_SAMPLINGpublic static final Builtins UNDER_SAMPLING 
 - 
UPPER_TRIpublic static final Builtins UPPER_TRI 
 - 
XDUMMY1public static final Builtins XDUMMY1 
 - 
XDUMMY2public static final Builtins XDUMMY2 
 
- 
 - 
Method Detail- 
valuespublic static Builtins[] values() Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:for (Builtins c : Builtins.values()) System.out.println(c); - Returns:
- an array containing the constants of this enum type, in the order they are declared
 
 - 
valueOfpublic static Builtins valueOf(String name) Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)- Parameters:
- name- the name of the enum constant to be returned.
- Returns:
- the enum constant with the specified name
- Throws:
- IllegalArgumentException- if this enum type has no constant with the specified name
- NullPointerException- if the argument is null
 
 - 
getNamepublic String getName() 
 - 
getAliaspublic String getAlias() 
 - 
isScriptpublic boolean isScript() 
 - 
isParameterizedpublic boolean isParameterized() 
 - 
isMultiReturnpublic boolean isMultiReturn() 
 - 
containspublic static boolean contains(String name, boolean script, boolean parameterized) 
 - 
getInternalFNamepublic static String getInternalFName(String name, Types.DataType dt) 
 
- 
 
-