Skip to content
Snippets Groups Projects
Commit 9f79b225 authored by Jakhes's avatar Jakhes
Browse files

Updating the doc Comments for the pl files

parent f7a17416
Branches
No related tags found
No related merge requests found
Showing with 531 additions and 312 deletions
:- module(ada_boost, [
initModelWithTraining/9,
:- module(ada_boost, [ initModelWithTraining/9,
initModelNoTraining/2,
classifyWithProb/8,
classifyNoProb/5,
......@@ -24,77 +23,77 @@
%% definitions for the connected function
%% TODO:
%% input: const MatType & data,
%% const arma::Row< size_t > & labels,
%% const size_t numClasses,
%% const WeakLearnerType & other,
%% const size_t iterations = 100,
%% const double tolerance = 1e-6
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelWithTraining, c, initModelWithTraining(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +integer, +string, +integer , +float32)).
%% TODO:
%% input: const double tolerance = 1e-6
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelNoTraining, c, initModelNoTraining(+float32, +string)).
%% TODO:
%% input: const MatType & test,
%% arma::Row< size_t > & predictedLabels,
%% arma::mat & probabilities
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(classifyWithProb, c, classifyWithProb(+pointer(float_array), +integer, +integer, -pointer(float_array), -integer, -pointer(float_array), -integer, -integer)).
%% TODO:
%% input: const MatType & test,
%% arma::Row< size_t > & predictedLabels
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(classifyNoProb, c, classifyNoProb(+pointer(float_array), +integer, +integer, -pointer(float_array), -integer)).
%% TODO:
%% input:
%% output: size_t classesNum
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(numClasses, c, numClasses([-integer])).
%% TODO:
%% input:
%% output: double tol
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(getTolerance, c, getTolerance([-float32])).
%% TODO:
%% input:
%% output: double& tol
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(modifyTolerance, c, modifyTolerance(+float32)).
%% TODO:
%% input: const MatType & data,
%% const arma::Row< size_t > & labels,
%% const size_t numClasses,
%% const WeakLearnerType & learner,
%% const size_t iterations = 100,
%% const double tolerance = 1e-6
%%
%% output: double upper bound training error
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(train, c, train(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +integer, +string, +integer , +float32, [-float32])).
%% Defines the functions that get connected from main.cpp
foreign_resource(ada_boost, [
initModelWithTraining,
foreign_resource(ada_boost, [ initModelWithTraining,
initModelNoTraining,
classifyWithProb,
classifyNoProb,
numClasses,
getTolerance,
modifyTolerance,
train
]).
train]).
:- load_foreign_resource(ada_boost).
\ No newline at end of file
......@@ -15,16 +15,93 @@
%% TODO: update Comment docs
%% definitions for the connected function and what there inputs and output arguments are
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModel, c, initModel(+integer, +integer, +integer, +float32)).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(alpha, c, alpha([-integer])).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(beta, c, beta([-integer])).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(dataOffset, c, dataOffset(-integer, [-pointer(float_array)])).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(dataScale, c, dataScale(-integer, [-pointer(float_array)])).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(omega, c, omega(-integer, [-pointer(float_array)])).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(predict, c, predict(+pointer(float_array), +integer, +integer, -pointer(float_array), -integer)).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(predictWithStd, c, predictWithStd(+pointer(float_array), +integer, +integer, -pointer(float_array), -integer, -pointer(float_array), -integer)).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(rmse, c, rmse(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, [-integer])).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(train, c, train(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer)).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(variance, c, variance([-integer])).
%% Defines what functions should be connected from main.cpp
......
......@@ -15,17 +15,20 @@
%% definitions for the connected function
%% input: double epsilon
%% --Input--
%% double epsilon
%% int minPoints
%% bool batchMode (1)true / (0)false
%% str selectionType "orderd", "random"
%% str treeType "kd", "r", "r_star", "x", "hilbert_r", "r_plus", "r_plus_plus", "cover", "ball"
%% mat data data(float_array), dataSize, dataRowNum
%% bool batchMode => (1)true / (0)false
%% str selectionType => "orderd", "random"
%% str treeType => "kd", "r", "r_star", "x", "hilbert_r", "r_plus", "r_plus_plus", "cover", "ball"
%% mat data => data(float_array), dataSize, dataRowNum
%%
%% output: vec assignments assign(float_array), assignSize
%% mat centroids cent(float_array), centColNum, centRowNum
%% --Output--
%% vec assignments => assign(float_array), assignSize
%% mat centroids => cent(float_array), centColNum, centRowNum
%%
%% description:
%% --Description--
foreign(dbscan, c, dbscan(+float32, +integer, +integer, +string, +string, +pointer(float_array), +integer, +integer,
-pointer(float_array), -integer, -pointer(float_array), -integer, -integer)).
......
......@@ -20,37 +20,47 @@
%% definitions for the connected function
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(naiveKMeans, c, naiveKMeans(+integer, +integer, +integer, +pointer(float_array), +integer, +integer, +integer,
-pointer(float_array), -integer, -pointer(float_array), -integer, -integer)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(dualTreeKMeans, c, dualTreeKMeans(+integer, +integer, +integer, +pointer(float_array), +integer, +integer, +integer,
-pointer(float_array), -integer, -pointer(float_array), -integer, -integer)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(elkanKMeans, c, elkanKMeans(+integer, +integer, +integer, +pointer(float_array), +integer, +integer, +integer,
-pointer(float_array), -integer, -pointer(float_array), -integer, -integer)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(hamerlyKMeans, c, hamerlyKMeans(+integer, +integer, +integer, +pointer(float_array), +integer, +integer, +integer,
-pointer(float_array), -integer, -pointer(float_array), -integer, -integer)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(pellegMooreKMeans, c, pellegMooreKMeans(+integer, +integer, +integer, +pointer(float_array), +integer, +integer, +integer,
-pointer(float_array), -integer, -pointer(float_array), -integer, -integer)).
......
......@@ -14,69 +14,108 @@
%% definitions for the connected function and what there inputs and output arguments are
%% Funktion
%% input const bool useCholesky, const double lambda1, const double lambda2, const double tolerance
%% output
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelNoDataNoGram, c, initModelNoDataNoGram(+integer, +float32, +float32, +float32)).
%% Funktion
%% input const bool useCholesky, const arma::mat & gramMatrix, const double lambda1, const double lambda2, const double tolerance
%% output
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelNoDataWithGram, c, initModelNoDataWithGram(+integer, +pointer(float_array), +integer, +integer, +float32, +float32, +float32)).
%% Funktion
%% input const arma::mat & dataMatrix, const arma::rowvec & responses, const bool transposeData, const bool useCholesky, const double lambda1, const double lambda2, const double tolerance
%% output
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelWithDataNoGram, c, initModelWithDataNoGram(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +integer, +integer, +float32, +float32, +float32)).
%% Funktion
%% input const arma::mat & dataMatrix, const arma::rowvec & responses, const bool transposeData, const bool useCholesky, const arma::mat & gramMatrix, const double lambda1, const double lambda2, const double tolerance
%% output
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelWithDataWithGram, c, initModelWithDataWithGram(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +integer, +integer, +pointer(float_array), +integer, +integer, +float32, +float32, +float32)).
%% Funktion
%% input
%% output const std::vector<size_t>&
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(activeSet, c, activeSet(-pointer(float_array), -integer)).
%% Funktion
%% input
%% output arma::vec&
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(beta, c, beta(-pointer(float_array), -integer)).
%% Funktion
%% input
%% output std::vector<arma::vec>&
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(betaPath, c, betaPath(-pointer(float_array), -integer, -integer)).
%% Funktion
%% input: const arma::mat &data, const arma::rowvec &responses, const bool rowMajor
%% output: double minimum cost error
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(computeError, c, computeError(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +integer, [-integer])).
%% Funktion
%% input
%% output std::vector<double>&
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(lambdaPath, c, lambdaPath(-pointer(float_array), -integer)).
%% Funktion
%% input
%% output arma::mat& upper triangular cholesky factor
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(matUtriCholFactor, c, matUtriCholFactor(-pointer(float_array), -integer, -integer)).
%% Funktion
%% input const arma::mat &points, arma::rowvec &predictions, const bool rowMajor
%% output
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(predict, c, predict(+pointer(float_array), +integer, +integer, -pointer(float_array), -integer, +integer)).
%% Funktion
%% input const arma::mat &data, const arma::rowvec &responses, arma::vec& beta, const bool transposeData
%% output double minimum cost error
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(train, c, train(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, -pointer(float_array), -integer, +integer, [-integer])).
%% Funktion
%% input const arma::mat &data, const arma::rowvec &responses, const bool transposeData
%% output double minimum cost error
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(trainNoBetaReturn, c, trainNoBetaReturn(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +integer, [-integer])).
......
......@@ -21,59 +21,55 @@
%% definitions for the connected function
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelWithTrain, c, initModelWithTrain(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +integer,
+float32, +float32, +integer, +string)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelNoTrain, c, initModelNoTrain( +integer, +float32, +float32, +integer)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(classify, c, classify(+pointer(float_array), +integer, +integer, -pointer(float_array), -integer, -pointer(float_array), -integer, -integer)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(classifyPoint, c, classifyPoint(+pointer(float_array), +integer, [-integer])).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(computeAccuracy, c, computeAccuracy(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, [-float32])).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(train, c, train(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +integer, +string, [-float32])).
%% +integer , +float32, +string
%% [-integer] , [-float32], [-string]
%% matrix input
%% +pointer(float_array), +integer, +integer
%% array input
%% +pointer(float_array), +integer
%% matrix return
%% -pointer(float_array), -integer, -integer
%% array return
%% -pointer(float_array), -integer
%% Defines the functions that get connected from main.cpp
foreign_resource(linear_SVM, [ initModelWithTrain,
initModelNoTrain,
......
......@@ -15,17 +15,101 @@
%% TODO: update Comment docs
%% definitions for the connected function and what there inputs and output arguments are
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModel, c, initModel(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +integer, +integer)).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelWithWeights, c, initModelWithWeights(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +pointer(float_array), +integer, +integer, +integer)).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelEmpty, c, initModelEmpty(+integer)).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(computeError, c, computeError(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, [-integer])).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(intercept, c, intercept([-integer])).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(lambda, c, lambda([-integer])).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(modifyLambda, c, modifyLambda(+integer)).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(parameters, c, parameters([-pointer(float_array)], -integer)).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(modifyParameters, c, modifyParameters(+pointer(float_array), +integer)).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(predict, c, predict(+pointer(float_array), +integer, +integer, -pointer(float_array), -integer)).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(train, c, train(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +integer, [-integer])).
%% TODO:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(trainWithWeights, c, trainWithWeights(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +pointer(float_array), +integer, +integer, [-integer])).
......
......@@ -23,51 +23,67 @@
%% definitions for the connected function
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelNoOptimizer, c, initModelNoOptimizer(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +float32)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelWithOptimizer, c, initModelWithOptimizer(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +string, +float32)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(classifyPoint, c, classifyPoint(+pointer(float_array), +integer, +float32, [-integer])).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(classifyLabels, c, classifyLabels(+pointer(float_array), +integer, +integer, -pointer(float_array), -integer, +float32)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(classifyProbs, c, classifyProbs(+pointer(float_array), +integer, +integer, -pointer(float_array), -integer, -integer)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(computeAccuracy, c, computeAccuracy(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +float32, [-float32])).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(computeError, c, computeError(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, [-float32])).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(train, c, train(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +string)).
......
......@@ -15,16 +15,19 @@
%% definitions for the connected function
%% TODO:
%% input: double radius >0
%% --Input--
%% double radius => 0
%% int maxIterations
%% mat data data(float_array), dataSize, dataRowNum
%% bool forceConvergence (1)true / (0)false
%% bool useSeeds (1)true / (0)false
%% mat data => data(float_array), dataSize, dataRowNum
%% bool forceConvergence => (1)true / (0)false
%% bool useSeeds => (1)true / (0)false
%%
%% --Output--
%% vec assignments => assign(float_array), assignSize
%% mat centroids => cent(float_array), centColNum, centRowNum
%%
%% output: vec assignments assign(float_array), assignSize
%% mat centroids cent(float_array), centColNum, centRowNum
%% description:
%% --Description--
foreign(meanShift, c, meanShift(+float32, +integer, +pointer(float_array), +integer, +integer, -pointer(float_array), -integer,
-pointer(float_array), -integer, -integer, +integer, +integer)).
......
......@@ -192,14 +192,3 @@ void variances(float **variancesMatArr, SP_integer *variancesMatColNum, SP_integ
// return the Matrix as one long Array
*variancesMatArr = convertToArray(variancesReturnMat);
}
\ No newline at end of file
// in file 'Code/User/snippets/javascript.json'
/*
{
"For Loop": {
"prefix": ["for", "for-const"],
"body": ["for (const ${2:element} of ${1:array}) {", "\t$0", "}"],
"description": "A for loop."
}
}
*/
\ No newline at end of file
......@@ -24,78 +24,79 @@
%% definitions for the connected function
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelWithTrain, c, initModelWithTrain(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +integer, +integer, +float32)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(initModelNoTrain, c, initModelNoTrain(+integer, +integer, +float32)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
%%foreign(classifyPoint, c, classifyPoint(+pointer(float_array), +integer, -integer, -pointer(float_array), -integer)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(classifyMatrix, c, classifyMatrix(+pointer(float_array), +integer, +integer, -pointer(float_array), -integer, -pointer(float_array), -integer, -integer)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(means, c, means(-pointer(float_array), -integer, -integer)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(probabilities, c, probabilities(-pointer(float_array), -integer, -integer)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(trainMatrix, c, trainMatrix(+pointer(float_array), +integer, +integer, +pointer(float_array), +integer, +integer, +integer)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(trainPoint, c, trainPoint(+pointer(float_array), +integer, +integer)).
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(variances, c, variances(-pointer(float_array), -integer, -integer)).
%% +integer , +float32, +string
%% [-integer] , [-float32], [-string]
%% matrix input
%% +pointer(float_array), +integer, +integer
%% array input
%% +pointer(float_array), +integer
%% matrix return
%% -pointer(float_array), -integer, -integer
%% array return
%% -pointer(float_array), -integer
%% Defines the functions that get connected from main.cpp
foreign_resource(naive_bayes_classifier, [ initModelWithTrain,
initModelNoTrain,
......
......@@ -16,9 +16,11 @@
%% definitions for the connected function
%% TODO:
%% input:
%% output:
%% description:
%% --Input--
%%
%% --Output--
%%
%% --Description--
foreign(function, c, function(arguments)).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment