R/FLRankMatrix.R

In Fuzzy-Logix/AdapteR: Converts R syntax to SQL to provide fast analytics using in-database C++ library DB Lytix.

#' @include FLMatrix.R
NULL

#' Matrix Rank.
#'
#' \code{rankMatrix} computes the rank of FLMatrix objects.
#'
#' @param object is of class FLMatrix
#' @param ... any additional arguments
#' @return \code{rankMatrix} returns R vector object of size 1 which replicates the equivalent R output.
#' @section Constraints:
#' Input can have maximum dimension limitations of (1000 x 1000).
#' @examples
#' flmatrix <- FLMatrix("tblMatrixMulti", 5,"MATRIX_ID","ROW_ID","COL_ID","CELL_VAL")
#' resultFLVector <- rankMatrix(flmatrix)
#' @export
rankMatrix<-function(object, ...){
	UseMethod("rankMatrix", object)
}

#' @export
rankMatrix.default <- Matrix::rankMatrix

#' @export
rankMatrix.FLMatrix<-function(object,...)
{
	connection<-getFLConnection(object)

	# sqlstr<-paste0(viewSelectMatrix(object,"a",withName="z"),
	# 			   outputSelectMatrix("FLMatrixRankUdt",
	# 			   					outColNames=list("OutputMtxRank"),viewName="z",localName="a")
	# 				)
    
    sqlstr <- constructMatrixUDTSQL(pObject=object,
                                    pFuncName="FLMatrixRankUdt",
                                    pdims=getDimsSlot(object),
                                    pdimnames=dimnames(object),
                                    pReturnQuery=TRUE
                                    )

	sqlstr <- gsub("'%insertIDhere%'",1,sqlstr)

	sqlstr <- (ensureQuerySize(pResult=sqlstr,
                                pInput=list(object),
                                pOperator="rankMatrix"))

	return(sqlQuery(connection,sqlstr)$"outputmtxrank"[1])
}