From ed526ee458eab28367de030f450838a038f2ed10 Mon Sep 17 00:00:00 2001 From: Harpreet Date: Tue, 1 Sep 2015 14:21:55 +0530 Subject: Styling help --- help/en_US/Symphony Native Function/CHAPTER | 1 + help/en_US/Symphony Native Function/CHAPTER~ | 1 + .../Symphony Native Function/sym_addConstr.xml | 76 ++++++++++++++++ help/en_US/Symphony Native Function/sym_addVar.xml | 82 +++++++++++++++++ help/en_US/Symphony Native Function/sym_close.xml | 59 ++++++++++++ .../Symphony Native Function/sym_deleteConstrs.xml | 61 +++++++++++++ .../Symphony Native Function/sym_deleteVars.xml | 61 +++++++++++++ .../sym_getConstrActivity.xml | 58 ++++++++++++ .../sym_getConstrLower.xml | 58 ++++++++++++ .../sym_getConstrRange.xml | 58 ++++++++++++ .../sym_getConstrSense.xml | 58 ++++++++++++ .../sym_getConstrUpper.xml | 58 ++++++++++++ .../Symphony Native Function/sym_getDblParam.xml | 61 +++++++++++++ .../Symphony Native Function/sym_getInfinity.xml | 57 ++++++++++++ .../Symphony Native Function/sym_getIntParam.xml | 61 +++++++++++++ .../Symphony Native Function/sym_getIterCount.xml | 58 ++++++++++++ .../Symphony Native Function/sym_getMatrix.xml | 58 ++++++++++++ .../Symphony Native Function/sym_getNumConstr.xml | 57 ++++++++++++ .../sym_getNumElements.xml | 57 ++++++++++++ .../Symphony Native Function/sym_getNumVar.xml | 57 ++++++++++++ .../Symphony Native Function/sym_getObjCoeff.xml | 58 ++++++++++++ .../Symphony Native Function/sym_getObjSense.xml | 57 ++++++++++++ .../Symphony Native Function/sym_getObjVal.xml | 58 ++++++++++++ .../sym_getPrimalBound.xml | 57 ++++++++++++ help/en_US/Symphony Native Function/sym_getRhs.xml | 58 ++++++++++++ .../Symphony Native Function/sym_getStatus.xml | 58 ++++++++++++ .../Symphony Native Function/sym_getStrParam.xml | 61 +++++++++++++ .../Symphony Native Function/sym_getVarLower.xml | 58 ++++++++++++ .../Symphony Native Function/sym_getVarSoln.xml | 58 ++++++++++++ .../Symphony Native Function/sym_getVarUpper.xml | 58 ++++++++++++ .../Symphony Native Function/sym_isAbandoned.xml | 58 ++++++++++++ .../Symphony Native Function/sym_isBinary.xml | 62 +++++++++++++ .../Symphony Native Function/sym_isContinuous.xml | 62 +++++++++++++ .../Symphony Native Function/sym_isEnvActive.xml | 57 ++++++++++++ .../Symphony Native Function/sym_isInfeasible.xml | 58 ++++++++++++ .../Symphony Native Function/sym_isInteger.xml | 46 ++++++++++ .../sym_isIterLimitReached.xml | 59 ++++++++++++ .../Symphony Native Function/sym_isOptimal.xml | 59 ++++++++++++ .../sym_isTargetGapAchieved.xml | 58 ++++++++++++ .../sym_isTimeLimitReached.xml | 58 ++++++++++++ .../en_US/Symphony Native Function/sym_loadMPS.xml | 62 +++++++++++++ .../Symphony Native Function/sym_loadProblem.xml | 99 ++++++++++++++++++++ .../sym_loadProblemBasic.xml | 100 +++++++++++++++++++++ help/en_US/Symphony Native Function/sym_open.xml | 59 ++++++++++++ .../Symphony Native Function/sym_resetParams.xml | 56 ++++++++++++ .../sym_setConstrLower.xml | 66 ++++++++++++++ .../Symphony Native Function/sym_setConstrType.xml | 76 ++++++++++++++++ .../sym_setConstrUpper.xml | 66 ++++++++++++++ .../Symphony Native Function/sym_setContinuous.xml | 61 +++++++++++++ .../Symphony Native Function/sym_setDblParam.xml | 65 ++++++++++++++ .../Symphony Native Function/sym_setIntParam.xml | 65 ++++++++++++++ .../Symphony Native Function/sym_setInteger.xml | 61 +++++++++++++ .../Symphony Native Function/sym_setObjCoeff.xml | 66 ++++++++++++++ .../Symphony Native Function/sym_setObjSense.xml | 62 +++++++++++++ .../sym_setPrimalBound.xml | 62 +++++++++++++ .../Symphony Native Function/sym_setStrParam.xml | 65 ++++++++++++++ .../Symphony Native Function/sym_setVarLower.xml | 66 ++++++++++++++ .../Symphony Native Function/sym_setVarSoln.xml | 63 +++++++++++++ .../Symphony Native Function/sym_setVarUpper.xml | 66 ++++++++++++++ help/en_US/Symphony Native Function/sym_solve.xml | 58 ++++++++++++ 60 files changed, 3599 insertions(+) create mode 100644 help/en_US/Symphony Native Function/CHAPTER create mode 100644 help/en_US/Symphony Native Function/CHAPTER~ create mode 100644 help/en_US/Symphony Native Function/sym_addConstr.xml create mode 100644 help/en_US/Symphony Native Function/sym_addVar.xml create mode 100644 help/en_US/Symphony Native Function/sym_close.xml create mode 100644 help/en_US/Symphony Native Function/sym_deleteConstrs.xml create mode 100644 help/en_US/Symphony Native Function/sym_deleteVars.xml create mode 100644 help/en_US/Symphony Native Function/sym_getConstrActivity.xml create mode 100644 help/en_US/Symphony Native Function/sym_getConstrLower.xml create mode 100644 help/en_US/Symphony Native Function/sym_getConstrRange.xml create mode 100644 help/en_US/Symphony Native Function/sym_getConstrSense.xml create mode 100644 help/en_US/Symphony Native Function/sym_getConstrUpper.xml create mode 100644 help/en_US/Symphony Native Function/sym_getDblParam.xml create mode 100644 help/en_US/Symphony Native Function/sym_getInfinity.xml create mode 100644 help/en_US/Symphony Native Function/sym_getIntParam.xml create mode 100644 help/en_US/Symphony Native Function/sym_getIterCount.xml create mode 100644 help/en_US/Symphony Native Function/sym_getMatrix.xml create mode 100644 help/en_US/Symphony Native Function/sym_getNumConstr.xml create mode 100644 help/en_US/Symphony Native Function/sym_getNumElements.xml create mode 100644 help/en_US/Symphony Native Function/sym_getNumVar.xml create mode 100644 help/en_US/Symphony Native Function/sym_getObjCoeff.xml create mode 100644 help/en_US/Symphony Native Function/sym_getObjSense.xml create mode 100644 help/en_US/Symphony Native Function/sym_getObjVal.xml create mode 100644 help/en_US/Symphony Native Function/sym_getPrimalBound.xml create mode 100644 help/en_US/Symphony Native Function/sym_getRhs.xml create mode 100644 help/en_US/Symphony Native Function/sym_getStatus.xml create mode 100644 help/en_US/Symphony Native Function/sym_getStrParam.xml create mode 100644 help/en_US/Symphony Native Function/sym_getVarLower.xml create mode 100644 help/en_US/Symphony Native Function/sym_getVarSoln.xml create mode 100644 help/en_US/Symphony Native Function/sym_getVarUpper.xml create mode 100644 help/en_US/Symphony Native Function/sym_isAbandoned.xml create mode 100644 help/en_US/Symphony Native Function/sym_isBinary.xml create mode 100644 help/en_US/Symphony Native Function/sym_isContinuous.xml create mode 100644 help/en_US/Symphony Native Function/sym_isEnvActive.xml create mode 100644 help/en_US/Symphony Native Function/sym_isInfeasible.xml create mode 100644 help/en_US/Symphony Native Function/sym_isInteger.xml create mode 100644 help/en_US/Symphony Native Function/sym_isIterLimitReached.xml create mode 100644 help/en_US/Symphony Native Function/sym_isOptimal.xml create mode 100644 help/en_US/Symphony Native Function/sym_isTargetGapAchieved.xml create mode 100644 help/en_US/Symphony Native Function/sym_isTimeLimitReached.xml create mode 100644 help/en_US/Symphony Native Function/sym_loadMPS.xml create mode 100644 help/en_US/Symphony Native Function/sym_loadProblem.xml create mode 100644 help/en_US/Symphony Native Function/sym_loadProblemBasic.xml create mode 100644 help/en_US/Symphony Native Function/sym_open.xml create mode 100644 help/en_US/Symphony Native Function/sym_resetParams.xml create mode 100644 help/en_US/Symphony Native Function/sym_setConstrLower.xml create mode 100644 help/en_US/Symphony Native Function/sym_setConstrType.xml create mode 100644 help/en_US/Symphony Native Function/sym_setConstrUpper.xml create mode 100644 help/en_US/Symphony Native Function/sym_setContinuous.xml create mode 100644 help/en_US/Symphony Native Function/sym_setDblParam.xml create mode 100644 help/en_US/Symphony Native Function/sym_setIntParam.xml create mode 100644 help/en_US/Symphony Native Function/sym_setInteger.xml create mode 100644 help/en_US/Symphony Native Function/sym_setObjCoeff.xml create mode 100644 help/en_US/Symphony Native Function/sym_setObjSense.xml create mode 100644 help/en_US/Symphony Native Function/sym_setPrimalBound.xml create mode 100644 help/en_US/Symphony Native Function/sym_setStrParam.xml create mode 100644 help/en_US/Symphony Native Function/sym_setVarLower.xml create mode 100644 help/en_US/Symphony Native Function/sym_setVarSoln.xml create mode 100644 help/en_US/Symphony Native Function/sym_setVarUpper.xml create mode 100644 help/en_US/Symphony Native Function/sym_solve.xml (limited to 'help/en_US/Symphony Native Function') diff --git a/help/en_US/Symphony Native Function/CHAPTER b/help/en_US/Symphony Native Function/CHAPTER new file mode 100644 index 0000000..8dd59e1 --- /dev/null +++ b/help/en_US/Symphony Native Function/CHAPTER @@ -0,0 +1 @@ +title = Symphony Native Functions diff --git a/help/en_US/Symphony Native Function/CHAPTER~ b/help/en_US/Symphony Native Function/CHAPTER~ new file mode 100644 index 0000000..a0a7f5d --- /dev/null +++ b/help/en_US/Symphony Native Function/CHAPTER~ @@ -0,0 +1 @@ +title = API Functions diff --git a/help/en_US/Symphony Native Function/sym_addConstr.xml b/help/en_US/Symphony Native Function/sym_addConstr.xml new file mode 100644 index 0000000..89ec114 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_addConstr.xml @@ -0,0 +1,76 @@ + + + + + sym_addConstr + Add a new constraint + + + + Calling Sequence + sym_addConstr(coeff,type,bound1[,bound2]) + + + + Description + + This function adds a new constraint from scratch. Supported types of constraints are less than or equal to, more than or equal to, equal to, or ranged. + The last argument is only required for ranged constraints. For the other types of constraints, only the third argument is required. + + + + + Arguments + + + + coeff + Sparse matrix representing coefficients of the variables in the new constraint (must have 1 row and number of columns equal to number of variables) + + + type + Type of the new constraint. Supported types: less than or equal to ("L"), greater than or equal to ("G"), equal to ("E"), or ranged ("R") + + + bound1 + The first (or only) bound for the constraint + + + bound2 + The second bound for ranged constraints. The two bounds for ranged constraints can be in any order. + + + + + + + Return value + + Returns 0 + + + + + Examples + + sym_addConstr(sparse([0,0,1,0,2]),"R",0,10) + sym_addConstr(sparse([0,0,1,1,0]),"G",4) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_addVar.xml b/help/en_US/Symphony Native Function/sym_addVar.xml new file mode 100644 index 0000000..7ba5c74 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_addVar.xml @@ -0,0 +1,82 @@ + + + + + sym_addVar + Add a new variable + + + + Calling Sequence + sym_addVar(coeff,lower,upper,obj,isInt,name) + + + + Description + + This function adds a new variable from scratch. + + + + + Arguments + + + + coeff + Sparse matrix representing coefficients of the new variable in the existing constraints (must have 1 column and number of rows equal to number of constraints) + + + lower + Lower bound of the new variable + + + upper + Upper bound of the new variable + + + obj + Coefficient of the variable in the objective function + + + isInt + Wether the variable is constrainted to be an integer (boolean %t or %f) + + + name + Name of the new variable + + + + + + + Return value + + Returns 0 + + + + + Examples + + sym_addVar(sparse([0;0;1;2;0;0]),0,%inf,1.2,%t,"part1") + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_close.xml b/help/en_US/Symphony Native Function/sym_close.xml new file mode 100644 index 0000000..5f2e903 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_close.xml @@ -0,0 +1,59 @@ + + + + + sym_close + Close the Symphony environment + + + + Calling Sequence + sym_close() + + + + Description + + Closes the already open Symphony environment. + Warning: All data loaded into the environment is deleted. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + Returns 1 if the environment was successfully closed and 0 otherwise + + + + + Examples + + sym_close() + + + + + Authors + + + Keyur Joshi + Iswarya + + + + + diff --git a/help/en_US/Symphony Native Function/sym_deleteConstrs.xml b/help/en_US/Symphony Native Function/sym_deleteConstrs.xml new file mode 100644 index 0000000..7c1aaa7 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_deleteConstrs.xml @@ -0,0 +1,61 @@ + + + + + sym_deleteConstrs + This routine is used to delete rows from the original constraint matrix. + + + + Calling Sequence + sym_deleteConstrs(indices) + + + + Description + + + + + + Arguments + + + + indices + An array indicating the indices of the rows to be deleted. + + + + + + + Return value + + Returns 0 if the constraints specified in the indices are deleted successfully and 0 if it returns corresponding to an error value. + + + + + Examples + + status=sym_deleteConstrs([1,2]) + + + + + Authors + + + Iswarya Hariharan + + + + + diff --git a/help/en_US/Symphony Native Function/sym_deleteVars.xml b/help/en_US/Symphony Native Function/sym_deleteVars.xml new file mode 100644 index 0000000..3ce1fe7 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_deleteVars.xml @@ -0,0 +1,61 @@ + + + + + sym_deleteVars + This routine is used to delete columns from the original problem description. + + + + Calling Sequence + sym_deleteVars(indices) + + + + Description + + + + + + Arguments + + + + indices + Pointer to an integer type array indicating the indices of the column numbers(variables) to be deleted. + + + + + + + Return value + + Returns 0 if the column numbers specified are deleted successfully and 0 if the deletion of column indices did not execute successfully and it returns with an error return value + + + + + Examples + + status=sym_deleteVars([1,2]) + + + + + Authors + + + Iswarya Hariharan + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getConstrActivity.xml b/help/en_US/Symphony Native Function/sym_getConstrActivity.xml new file mode 100644 index 0000000..7323a48 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getConstrActivity.xml @@ -0,0 +1,58 @@ + + + + + sym_getConstrActivity + Get the activity of the constraints in the solution + + + + Calling Sequence + sym_getConstrActivity() + + + + Description + + Get the activity of the constraints in the solution. + This function may fail if the problem has not been solved already. Use sym_solve() in this case. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + Returns a matrix with 1 column and number of rows equal to number of constraints, that represents the activities of those constraints + + + + + Examples + + sym_getConstrActivity() + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getConstrLower.xml b/help/en_US/Symphony Native Function/sym_getConstrLower.xml new file mode 100644 index 0000000..8274813 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getConstrLower.xml @@ -0,0 +1,58 @@ + + + + + sym_getConstrLower + To get the lower bounds of the constraints. + + + + Calling Sequence + sym_getConstrLower() + + + + Description + + This routine is used to get lower bounds of constraints. + If there was an error it prints to Scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns a column vector of lower bounds of constraints. + + + + + Examples + + ans=sym_getConstrLower() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getConstrRange.xml b/help/en_US/Symphony Native Function/sym_getConstrRange.xml new file mode 100644 index 0000000..402f313 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getConstrRange.xml @@ -0,0 +1,58 @@ + + + + + sym_getConstrRange + To to get the constraint ranges. + + + + Calling Sequence + sym_getConstrRange() + + + + Description + + This routine is used to get the constraint ranges. + If there was an error it prints to Scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns a column vector of the constraint ranges. + + + + + Examples + + ans=sym_getConstrRange() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getConstrSense.xml b/help/en_US/Symphony Native Function/sym_getConstrSense.xml new file mode 100644 index 0000000..85d358c --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getConstrSense.xml @@ -0,0 +1,58 @@ + + + + + sym_getConstrSense + To get the row senses. + + + + Calling Sequence + sym_getConstrSense() + + + + Description + + This routine is used to get the row senses. + If there was an error it prints to Scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns a column vector of the row senses. + + + + + Examples + + ans=sym_getConstrSense() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getConstrUpper.xml b/help/en_US/Symphony Native Function/sym_getConstrUpper.xml new file mode 100644 index 0000000..5422d96 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getConstrUpper.xml @@ -0,0 +1,58 @@ + + + + + sym_getConstrUpper + To get the upper bounds of the constraints. + + + + Calling Sequence + sym_getConstrUpper() + + + + Description + + This routine is used to get upper bounds of the constraints. + If there was an error it prints to Scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns a column vector of upper bounds of constraints. + + + + + Examples + + ans=sym_getConstrUpper() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getDblParam.xml b/help/en_US/Symphony Native Function/sym_getDblParam.xml new file mode 100644 index 0000000..4e5d8f3 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getDblParam.xml @@ -0,0 +1,61 @@ + + + + + sym_getDblParam + This routine is used to get the value of a double type parameter. + + + + Calling Sequence + sym_getDblParam(key) + + + + Description + + + + + + Arguments + + + + key + The name of the double parameter whose value has to be retrieved. Note: should be given within " " + + + + + + + Return value + + Returns 0 if the parameter's value has been successfully retrieved and displayed on the console ,else 1 is returned corressponding to an error value for the unsuccessful execution of the function + + + + + Examples + + status=sym_getDblParam("time_limit") + + + + + Authors + + + Iswarya Hariharan + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getInfinity.xml b/help/en_US/Symphony Native Function/sym_getInfinity.xml new file mode 100644 index 0000000..295fd17 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getInfinity.xml @@ -0,0 +1,57 @@ + + + + + sym_getInfinity + Get Symphony's infinity value + + + + Calling Sequence + sym_getInfinity() + + + + Description + + Get the value that Symphony considers to be infinity. This is equal to 10^20. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + Returns the infinity value of Symphony + + + + + Examples + + sym_getInfinity() + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getIntParam.xml b/help/en_US/Symphony Native Function/sym_getIntParam.xml new file mode 100644 index 0000000..a6626af --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getIntParam.xml @@ -0,0 +1,61 @@ + + + + + sym_getIntParam + This routine is used to get the value of an integer type parameter. + + + + Calling Sequence + sym_getIntParam(key) + + + + Description + + + + + + Arguments + + + + key + The name of the integer parameter whose value has to be retrieved. Note: should be given within " " + + + + + + + Return value + + Returns 0 if the parameter's value has been successfully retrieved and displayed on the console ,else 1 is returned corressponding to an error value for the unsuccessful execution of the function + + + + + Examples + + status=sym_getIntParam("verbosity") + + + + + Authors + + + Iswarya Hariharan + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getIterCount.xml b/help/en_US/Symphony Native Function/sym_getIterCount.xml new file mode 100644 index 0000000..ab7f42e --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getIterCount.xml @@ -0,0 +1,58 @@ + + + + + sym_getIterCount + To get the number of the analyzed nodes of the branching tree after solving the problem. + + + + Calling Sequence + sym_getIterCount() + + + + Description + + This routine is used to get the number of the analyzed nodes of the branching tree after solving the problem. + If there was an error it prints to Scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns iteration count. + + + + + Examples + + ans=sym_getIterCount() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getMatrix.xml b/help/en_US/Symphony Native Function/sym_getMatrix.xml new file mode 100644 index 0000000..fbcd87f --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getMatrix.xml @@ -0,0 +1,58 @@ + + + + + sym_getMatrix + To get the constraint matrix. + + + + Calling Sequence + sym_getMatrix() + + + + Description + + This routine is used to get the constraint matrix as sparse matrix in a standard row-ordered format. + If there was an error it prints to Scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns a row-ordered sparse matrix. + + + + + Examples + + ans=sym_getMatrix() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getNumConstr.xml b/help/en_US/Symphony Native Function/sym_getNumConstr.xml new file mode 100644 index 0000000..63715fb --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getNumConstr.xml @@ -0,0 +1,57 @@ + + + + + sym_getNumConstr + To get the number of the constraints of the current problem. + + + + Calling Sequence + sym_getNumConstr() + + + + Description + + This routine is used to get the number of the constraints of the current problem. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + If there was an error it prints error message to Scilab console and returns -1, else it returns a number ( >=0 ) as number of constraints. + + + + + Examples + + ans=sym_getNumConstr() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getNumElements.xml b/help/en_US/Symphony Native Function/sym_getNumElements.xml new file mode 100644 index 0000000..5ce71a9 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getNumElements.xml @@ -0,0 +1,57 @@ + + + + + sym_getNumElements + To get the number of non-zero entries of the constraint matrix of the current problem. + + + + Calling Sequence + sym_getNumElements() + + + + Description + + This routine is used to get the number of non-zero entries of the constraint matrix of the current problem. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + If there was an error, it prints error message to Scilab console and returns -1, else it returns a number ( >=0 ) as number of non-zero elements. + + + + + Examples + + ans=sym_getNumElements() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getNumVar.xml b/help/en_US/Symphony Native Function/sym_getNumVar.xml new file mode 100644 index 0000000..5602811 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getNumVar.xml @@ -0,0 +1,57 @@ + + + + + sym_getNumVar + To get the number of the variables of the current problem. + + + + Calling Sequence + sym_getNumVar() + + + + Description + + This routine is used to get the number of the variables of the current problem. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + If there was an error it prints error message to Scilab console and returns -1, else it returns a number ( >=0 ) as number of variables. + + + + + Examples + + ans=sym_getNumVar() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getObjCoeff.xml b/help/en_US/Symphony Native Function/sym_getObjCoeff.xml new file mode 100644 index 0000000..194d3cd --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getObjCoeff.xml @@ -0,0 +1,58 @@ + + + + + sym_getObjCoeff + To get the objective vector. + + + + Calling Sequence + sym_getObjCoeff() + + + + Description + + This routine is used to get the objective vector. + If there was an error it prints to Scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns a row vector of coefficients of variables in objective. + + + + + Examples + + ans=sym_getObjCoeff() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getObjSense.xml b/help/en_US/Symphony Native Function/sym_getObjSense.xml new file mode 100644 index 0000000..1d4f0fa --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getObjSense.xml @@ -0,0 +1,57 @@ + + + + + sym_getObjSense + Get the objective sense + + + + Calling Sequence + sym_getObjSense() + + + + Description + + This function gets the sense of the objective function (minimization/maximization). + + + + + Arguments + + This function takes no arguments + + + + + Return value + + Returns 1 if the objective is to be minimized and -1 if the objective is to be maximized + + + + + Examples + + sym_getObjSense() + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getObjVal.xml b/help/en_US/Symphony Native Function/sym_getObjVal.xml new file mode 100644 index 0000000..9a65646 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getObjVal.xml @@ -0,0 +1,58 @@ + + + + + sym_getObjVal + Get the optimized objective value + + + + Calling Sequence + sym_getObjVal() + + + + Description + + Get the optimized objective value after after solving the problem. + This function may fail if the problem has not been solved already. Use sym_solve() in this case. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + Returns the optimized objective value + + + + + Examples + + sym_getObjVal() + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getPrimalBound.xml b/help/en_US/Symphony Native Function/sym_getPrimalBound.xml new file mode 100644 index 0000000..3b9db8d --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getPrimalBound.xml @@ -0,0 +1,57 @@ + + + + + sym_getPrimalBound + Get the primal bound of the problem + + + + Calling Sequence + sym_getPrimalBound() + + + + Description + + Get the primal bound of the loaded problem. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + Returns the primal bound of the problem + + + + + Examples + + sym_getPrimalBound() + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getRhs.xml b/help/en_US/Symphony Native Function/sym_getRhs.xml new file mode 100644 index 0000000..a0d1a76 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getRhs.xml @@ -0,0 +1,58 @@ + + + + + sym_getRhs + To to get the right hand side vector(column vector). + + + + Calling Sequence + sym_getRhs() + + + + Description + + This routine is used to get the right hand side vector(coumn vector). + If there was an error it prints to Scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns a column vector of the right hand side values of constraints. + + + + + Examples + + ans=sym_getRhs() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getStatus.xml b/help/en_US/Symphony Native Function/sym_getStatus.xml new file mode 100644 index 0000000..f13e59e --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getStatus.xml @@ -0,0 +1,58 @@ + + + + + sym_getStatus + To get status of the problem solver. + + + + Calling Sequence + sym_getStatus() + + + + Description + + This post-solution query routine is used to learn the termination status of the solution procedure. + It prints status of the problem solver to scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns 1 if it receives any return-value indicating an error message or 0 if it receives any return-value indicating a non-error message. + + + + + Examples + + status=sym_getStatus() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getStrParam.xml b/help/en_US/Symphony Native Function/sym_getStrParam.xml new file mode 100644 index 0000000..b261053 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getStrParam.xml @@ -0,0 +1,61 @@ + + + + + sym_getStrParam + This routine is used to get the value of a string type parameter. + + + + Calling Sequence + sym_getStrParam(key) + + + + Description + + + + + + Arguments + + + + key + The name of the strung parameter whose value has to be retrieved. Note: should be given within " " + + + + + + + Return value + + Returns 0 if the parameter's value has been successfully retrieved and displayed on the console ,else 1 is returned corressponding to an error value for the unsuccessful execution of the function + + + + + Examples + + status=sym_getStrParam("source_path") + + + + + Authors + + + Iswarya Hariharan + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getVarLower.xml b/help/en_US/Symphony Native Function/sym_getVarLower.xml new file mode 100644 index 0000000..771d095 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getVarLower.xml @@ -0,0 +1,58 @@ + + + + + sym_getVarLower + To get the lower bounds of the variables. + + + + Calling Sequence + sym_getVarLower() + + + + Description + + This routine is used to get the lower bounds of the variables. + If there was an error it prints to Scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns a row vector of lower bounds of the variables. + + + + + Examples + + ans=sym_getVarLower() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getVarSoln.xml b/help/en_US/Symphony Native Function/sym_getVarSoln.xml new file mode 100644 index 0000000..5500c57 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getVarSoln.xml @@ -0,0 +1,58 @@ + + + + + sym_getVarSoln + Get the solution for the problem + + + + Calling Sequence + sym_getVarSoln() + + + + Description + + Get the solution for the problem after solving it. + This function may fail if the problem has not been solved already. Use sym_solve() in this case. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + Returns a matrix with 1 row and number of columns equal to number of variables, that represents the solutions for those variables + + + + + Examples + + sym_getVarSoln() + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_getVarUpper.xml b/help/en_US/Symphony Native Function/sym_getVarUpper.xml new file mode 100644 index 0000000..a447a54 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_getVarUpper.xml @@ -0,0 +1,58 @@ + + + + + sym_getVarUpper + To get the upper bounds of the variables. + + + + Calling Sequence + sym_getVarUpper() + + + + Description + + This routine is used to get the upper bounds of the variables. + If there was an error it prints to Scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns a row vector of upper bounds of the variables. + + + + + Examples + + ans=sym_getVarUpper() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_isAbandoned.xml b/help/en_US/Symphony Native Function/sym_isAbandoned.xml new file mode 100644 index 0000000..1009201 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isAbandoned.xml @@ -0,0 +1,58 @@ + + + + + sym_isAbandoned + To check whether the problem was abandoned for some reason. + + + + Calling Sequence + sym_isAbandoned() + + + + Description + + This post-solution query routine is used to learn whether the problem was abandoned for some reason. + It prints whether or not the problem was abandoned for some reason to scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns 1 if the problem was abandoned or 0 if the problem was not abandoned or -1 if there was an error. + + + + + Examples + + status=sym_isAbandoned() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_isBinary.xml b/help/en_US/Symphony Native Function/sym_isBinary.xml new file mode 100644 index 0000000..57a6cf3 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isBinary.xml @@ -0,0 +1,62 @@ + + + + + sym_isBinary + Check if a variable is constrained to be binary + + + + Calling Sequence + sym_isBinary(index) + + + + Description + + This function checks if a variable is constrained to be binary (0 or 1). + + + + + Arguments + + + + index + Index of the variable to check. Must be in {0,1,2,...n-1} where n is the number of variables in the problem + + + + + + + Return value + + Returns 1 if the variable is constrained to be binary and 0 if it is not. + + + + + Examples + + sym_isBinary(2) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_isContinuous.xml b/help/en_US/Symphony Native Function/sym_isContinuous.xml new file mode 100644 index 0000000..8c6a77b --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isContinuous.xml @@ -0,0 +1,62 @@ + + + + + sym_isContinuous + Check if a variable is continuous + + + + Calling Sequence + sym_isContinuous(index) + + + + Description + + This function checks if a variable is continuous. + + + + + Arguments + + + + index + Index of the variable to check. Must be in {0,1,2,...n-1} where n is the number of variables in the problem + + + + + + + Return value + + Returns 1 if the variable is continuous and 0 if it is not. + + + + + Examples + + sym_isContinuous(2) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_isEnvActive.xml b/help/en_US/Symphony Native Function/sym_isEnvActive.xml new file mode 100644 index 0000000..b47e28b --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isEnvActive.xml @@ -0,0 +1,57 @@ + + + + + sym_isEnvActive + Check if Symphony environment is active + + + + Calling Sequence + sym_isEnvActive() + + + + Description + + Check if Symphony environment is active (open). Most Symphony functions will require the environment to be open. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + Returns 1 if the environment is active and 0 otherwise + + + + + Examples + + sym_isEnvActive() + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_isInfeasible.xml b/help/en_US/Symphony Native Function/sym_isInfeasible.xml new file mode 100644 index 0000000..88a4f43 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isInfeasible.xml @@ -0,0 +1,58 @@ + + + + + sym_isInfeasible + To check whether the problem was proven to be infeasible. + + + + Calling Sequence + sym_isInfeasible() + + + + Description + + This post-solution query routine is used to learn whether the problem was proven to be infeasible. + It prints whether or not the problem was proven to be infeasible to scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns 1 if the problem was solved proven to be infeasible or 0 if it was not proven to be infeasible or -1 if there was an error. + + + + + Examples + + status=sym_isInfeasible() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_isInteger.xml b/help/en_US/Symphony Native Function/sym_isInteger.xml new file mode 100644 index 0000000..e104039 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isInteger.xml @@ -0,0 +1,46 @@ + + + + + sym_isInteger + + Check if a variable is constrained to be an integer + + + + Calling Sequence + + sym_isInteger(index) + + + + Description + + This function checks if a variable is constrained to be an integer. + index : Index of the variable to check. Must be in {0,1,2,...n-1} where n is the number of variables in the problem + + + + + Examples + + sym_isInteger(2) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_isIterLimitReached.xml b/help/en_US/Symphony Native Function/sym_isIterLimitReached.xml new file mode 100644 index 0000000..013f984 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isIterLimitReached.xml @@ -0,0 +1,59 @@ + + + + + sym_isIterLimitReached + To know whether the iteration limit (node limit) was reached. + + + + Calling Sequence + sym_isIterLimitReached() + + + + Description + + This post-solution query routine is used to learn whether the iteration limit(node limit) was reached. + It prints whether or not the iteration limit (node limit) was reached to scilab console. + It can also be used if "find first feasible" parameter was set to true before solving the problem. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns 1 if the iteration limit is reached or 0 if the iteration limit is not reached or -1 if there was an error. + + + + + Examples + + status=sym_isIterLimitReached() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_isOptimal.xml b/help/en_US/Symphony Native Function/sym_isOptimal.xml new file mode 100644 index 0000000..889aa02 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isOptimal.xml @@ -0,0 +1,59 @@ + + + + + sym_isOptimal + To check whether the problem was solved to optimality. + + + + Calling Sequence + sym_isOptimal() + + + + Description + + This post-solution query routine is used to learn whether the problem was solved to + optimality. + It prints whether or not the problem was solved to optimality to scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns 1 if the problem was solved to optimality or 0 if it was not solved to optimality or -1 if there was an error. + + + + + Examples + + status=sym_isOptimal() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_isTargetGapAchieved.xml b/help/en_US/Symphony Native Function/sym_isTargetGapAchieved.xml new file mode 100644 index 0000000..81c99b4 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isTargetGapAchieved.xml @@ -0,0 +1,58 @@ + + + + + sym_isTargetGapAchieved + To know whether the target gap was reached. + + + + Calling Sequence + sym_isTargetGapAchieved() + + + + Description + + This post-solution query routine is used to learn whether the target gap was reached. + It print whether or not the target gap was reached. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns 1 if the target gap was reached or 0 if the target gap was not reached or -1 if there was an error. + + + + + Examples + + status=sym_isTargetGapAchieved() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_isTimeLimitReached.xml b/help/en_US/Symphony Native Function/sym_isTimeLimitReached.xml new file mode 100644 index 0000000..42889de --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_isTimeLimitReached.xml @@ -0,0 +1,58 @@ + + + + + sym_isTimeLimitReached + To know whether the time limit was reached. + + + + Calling Sequence + sym_isTimeLimitReached() + + + + Description + + This post-solution query routine is used to learn whether the time limit was reached. + It prints whether or not the time limit was reached to scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns 1 if the time limit was reached or 0 if the time limit was not reached or -1 if there was an error. + + + + + Examples + + status=sym_isTimeLimitReached() + + + + + Authors + + + Sai Kiran Naragam + + + + + diff --git a/help/en_US/Symphony Native Function/sym_loadMPS.xml b/help/en_US/Symphony Native Function/sym_loadMPS.xml new file mode 100644 index 0000000..6e55cff --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_loadMPS.xml @@ -0,0 +1,62 @@ + + + + + sym_loadMPS + This routine is used to load an instance from an MPS file. + + + + Calling Sequence + sym_loadMPS(filename) + + + + Description + + + + + + Arguments + + + + filename + It is a string that has the path of the .mps file to loaded.It has to be given within double quotes ("") + + + + + + + Return value + + Returns 0 if the .mps file is loaded properly to symphony and 0 if there is an error reading the mps file or the function returns with an error return value + + + + + Examples + + status=sym_loadMPS("./sample.mps") -mps file present in the current directory of execution can be mentioned this way also + status=sym_loadMPS("/home/Desktop/sample.mps") -mps file present at a different location must be specified with their entire path + + + + + Authors + + + Iswarya Hariharan + + + + + diff --git a/help/en_US/Symphony Native Function/sym_loadProblem.xml b/help/en_US/Symphony Native Function/sym_loadProblem.xml new file mode 100644 index 0000000..e2409c5 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_loadProblem.xml @@ -0,0 +1,99 @@ + + + + + sym_loadProblem + Load a problem into Symphony + + + + Calling Sequence + sym_loadProblem(nbVar,nbConstr,varLB,varUB,objCoeff,isInt,objSense,conMatrix,conLB,conUB) + + + + Description + + Loads a MIP problem into Symphony. All the necessary data can be given through a single function call. + The type of constraint is automatically deduced from the constraint bounds. + + + + + Arguments + + + + nbVar + Number of variables + + + nbConstr + Number of constraints + + + varLB + Matrix containing lower bounds of the variables (must have size 1 row and nbVar columns). Bound can be negative infinity + + + varUB + Matrix containing upper bounds of the variables (must have size 1 row and nbVar columns). Bound can be infinity + + + objCoeff + Matrix containing coefficients of the variables in the objective (must have size 1 row and nbVar columns) + + + isInt + Boolean matrix representing wether a variable is constrained to be an integer (must have size 1 row and nbVar columns) + + + objSense + The sense (maximization/minimization) of the objective. Use sym_minimize or sym_maximize here + + + conMatrix + Sparse matrix representing the constraint matrix (must have size nbConstr rows and nbVar columns) + + + conLB + Matrix containing lower bounds of the constraints (must have size nbConstr rows and 1 column) + + + conUB + Matrix containing upper bounds of the constraints (must have size nbConstr rows and 1 column) + + + + + + + Return value + + Returns 0 if the problem was successfully loaded into Symphony + + + + + Examples + + sym_loadProblem(2,2,[0,0],[%inf,%inf],[1,1],[%t,%t],sym_maximize,sparse([1,2;2,1]),[0;0],[7;6.5]) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_loadProblemBasic.xml b/help/en_US/Symphony Native Function/sym_loadProblemBasic.xml new file mode 100644 index 0000000..90a5995 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_loadProblemBasic.xml @@ -0,0 +1,100 @@ + + + + + sym_loadProblemBasic + Load a problem into Symphony (basic version) + + + + Calling Sequence + sym_loadProblemBasic(nbVar,nbConstr,varLB,varUB,objCoeff,isInt,objSense,conMatrix,conLB,conUB) + + + + Description + + Loads a MIP problem into Symphony. All the necessary data can be given through a single function call. + The type of constraint is automatically deduced from the constraint bounds. + This version of the problem loader does not support sparse matrices and hence is only useful for small problems. + + + + + Arguments + + + + nbVar + Number of variables + + + nbConstr + Number of constraints + + + varLB + Matrix containing lower bounds of the variables (must have size 1 row and nbVar columns). Bound can be negative infinity + + + varUB + Matrix containing upper bounds of the variables (must have size 1 row and nbVar columns). Bound can be infinity + + + objCoeff + Matrix containing coefficients of the variables in the objective (must have size 1 row and nbVar columns) + + + isInt + Boolean matrix representing wether a variable is constrained to be an integer (must have size 1 row and nbVar columns) + + + objSense + The sense (maximization/minimization) of the objective. Use sym_minimize or sym_maximize here + + + conMatrix + Matrix (normal) representing the constraint matrix (must have size nbConstr rows and nbVar columns) + + + conLB + Matrix containing lower bounds of the constraints (must have size nbConstr rows and 1 column) + + + conUB + Matrix containing upper bounds of the constraints (must have size nbConstr rows and 1 column) + + + + + + + Return value + + Returns 0 if the problem was successfully loaded into Symphony + + + + + Examples + + sym_loadProblemBasic(2,2,[0,0],[%inf,%inf],[1,1],[%t,%t],sym_maximize,[1,2;2,1],[0;0],[7;6.5]) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_open.xml b/help/en_US/Symphony Native Function/sym_open.xml new file mode 100644 index 0000000..92b3dec --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_open.xml @@ -0,0 +1,59 @@ + + + + + sym_open + Open the Symphony environment + + + + Calling Sequence + sym_open() + + + + Description + + Opens the Symphony environment. The environment and all data loaded into it is maintained across function calls. + This function fails if the environment is already open. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + Returns 1 if the environment was successfully opened and 0 otherwise + + + + + Examples + + sym_open() + + + + + Authors + + + Keyur Joshi + Iswarya + + + + + diff --git a/help/en_US/Symphony Native Function/sym_resetParams.xml b/help/en_US/Symphony Native Function/sym_resetParams.xml new file mode 100644 index 0000000..a73fdbd --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_resetParams.xml @@ -0,0 +1,56 @@ + + + + + sym_resetParams + This routine sets all the environment variables and parameters to their default values. + + + + Calling Sequence + sym_resetParams() + + + + Description + + + + + + Arguments + + This function takes no arguments + + + + + Return value + + Returns 0 if the environment variables and parameters are set to their default value and 1 if a value corresponding to an error is returned + + + + + Examples + + status=sym_resetParams() + + + + + Authors + + + Iswarya Hariharan + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setConstrLower.xml b/help/en_US/Symphony Native Function/sym_setConstrLower.xml new file mode 100644 index 0000000..ae68046 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setConstrLower.xml @@ -0,0 +1,66 @@ + + + + + sym_setConstrLower + Set the lower bound of a constraint + + + + Calling Sequence + sym_setConstrLower(index,newBound) + + + + Description + + This function changes the lower bound of a constraint + + + + + Arguments + + + + index + Index of the constraint to modify. Must be in {0,1,2,...n-1} where n is the number of constraints in the problem + + + newBound + The new lower bound for the constraint + + + + + + + Return value + + Returns 0 + + + + + Examples + + sym_setConstrLower(2,-100) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setConstrType.xml b/help/en_US/Symphony Native Function/sym_setConstrType.xml new file mode 100644 index 0000000..18afed0 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setConstrType.xml @@ -0,0 +1,76 @@ + + + + + sym_setConstrType + Set the type of a constraint + + + + Calling Sequence + sym_setConstrType(index,type,bound1[,bound2]) + + + + Description + + This function completely modifies the type of a constraint. Supported types of constraints are less than or equal to, more than or equal to, equal to, or ranged. + The last argument is only required for ranged constraints. For the other types of constraints, only the third argument is required. + + + + + Arguments + + + + index + Index of the constraint to modify. Must be in {0,1,2,...n-1} where n is the number of constraints in the problem + + + type + New type of the constraint. Supported types: less than or equal to ("L"), greater than or equal to ("G"), equal to ("E"), or ranged ("R") + + + bound1 + The first (or only) bound for the constraint + + + bound2 + The second bound for ranged constraints. The two bounds for ranged constraints can be in any order. + + + + + + + Return value + + Returns 0 + + + + + Examples + + sym_setConstrType(2,"R",-10,10) + sym_setConstrType(3,"E",100) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setConstrUpper.xml b/help/en_US/Symphony Native Function/sym_setConstrUpper.xml new file mode 100644 index 0000000..676454c --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setConstrUpper.xml @@ -0,0 +1,66 @@ + + + + + sym_setConstrUpper + Set the upper bound of a constraint + + + + Calling Sequence + sym_setConstrUpper(index,newBound) + + + + Description + + This function changes the upper bound of a constraint + + + + + Arguments + + + + index + Index of the constraint to modify. Must be in {0,1,2,...n-1} where n is the number of constraints in the problem + + + newBound + The new upper bound for the constraint + + + + + + + Return value + + Returns 0 + + + + + Examples + + sym_setConstrUpper(2,-100) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setContinuous.xml b/help/en_US/Symphony Native Function/sym_setContinuous.xml new file mode 100644 index 0000000..f4948d9 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setContinuous.xml @@ -0,0 +1,61 @@ + + + + + sym_setContinuous + This routine is used to set the type of a variable to be continuous. + + + + Calling Sequence + sym_setContinuous(index) + + + + Description + + + + + + Arguments + + + + index + Index of the variable to be set continuous + + + + + + + Return value + + Returns 0 if the variable type has been set as continuous and 0 if an error value is returned. + + + + + Examples + + status=sym_setContinuous(1) + + + + + Authors + + + Iswarya Hariharan + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setDblParam.xml b/help/en_US/Symphony Native Function/sym_setDblParam.xml new file mode 100644 index 0000000..464d29e --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setDblParam.xml @@ -0,0 +1,65 @@ + + + + + sym_setDblParam + This routine is used to set a double type parameter. + + + + Calling Sequence + sym_setDblParam(key,value) + + + + Description + + + + + + Arguments + + + + key + The name of the double type parameter to be set. Note: should be given within " " + + + value + New value of the corresponding double parameter + + + + + + + Return value + + Returns 0 if the parameter specified is set to the value mentioned and 0 if setting of the double parameter was unsuccessful due to invalid inputs + + + + + Examples + + status=sym_setDblParam("time_limit",5) + + + + + Authors + + + Iswarya Hariharan + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setIntParam.xml b/help/en_US/Symphony Native Function/sym_setIntParam.xml new file mode 100644 index 0000000..e20dfb5 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setIntParam.xml @@ -0,0 +1,65 @@ + + + + + sym_setIntParam + This routine is used to set an integer type parameter. + + + + Calling Sequence + sym_setIntParam(key,value) + + + + Description + + + + + + Arguments + + + + key + The name of the parameter to be set. Note:should be given within " " + + + value + New value of the corresponding integer parameter + + + + + + + Return value + + Returns 0 if the parameter specified is set to the value mentioned and 0 if setting of the integer parameter was unsuccessful due to invalid inputs + + + + + Examples + + status=sym_setIntParam("verbosity",5) + + + + + Authors + + + Iswarya Hariharan + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setInteger.xml b/help/en_US/Symphony Native Function/sym_setInteger.xml new file mode 100644 index 0000000..cebb83f --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setInteger.xml @@ -0,0 +1,61 @@ + + + + + sym_setInteger + This routine is used to set the type of a variable to be integer. + + + + Calling Sequence + sym_setInteger(index) + + + + Description + + + + + + Arguments + + + + index + The index of the variable type to be modified as integer. Note that, it has to be at most the number of columns. + + + + + + + Return value + + Returns 0 if the variable type has been set as integer and 0 if an error value is returned. + + + + + Examples + + status=sym_setInteger(1) + + + + + Authors + + + Iswarya Hariharan + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setObjCoeff.xml b/help/en_US/Symphony Native Function/sym_setObjCoeff.xml new file mode 100644 index 0000000..5251b4c --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setObjCoeff.xml @@ -0,0 +1,66 @@ + + + + + sym_setObjCoeff + Set coefficient of a variable in the objective + + + + Calling Sequence + sym_setObjCoeff(index,newCoeff) + + + + Description + + This function changes the coefficient of a variable in the objective function + + + + + Arguments + + + + index + Index of the variable to modify. Must be in {0,1,2,...n-1} where n is the number of variables in the problem + + + newCoeff + The new coefficient of the variable + + + + + + + Return value + + Returns 0 + + + + + Examples + + sym_setObjCoeff(2,1.5) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setObjSense.xml b/help/en_US/Symphony Native Function/sym_setObjSense.xml new file mode 100644 index 0000000..356ea97 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setObjSense.xml @@ -0,0 +1,62 @@ + + + + + sym_setObjSense + Set the objective sense + + + + Calling Sequence + sym_setObjSense(sense) + + + + Description + + This function sets the sense of the objective function (minimization/maximization). + + + + + Arguments + + + + sense + The new sense of the objective function. Use sym_minimize or sym_maximize here + + + + + + + Return value + + Returns 0 + + + + + Examples + + sym_setObjSense(sym_minimize) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setPrimalBound.xml b/help/en_US/Symphony Native Function/sym_setPrimalBound.xml new file mode 100644 index 0000000..c2f29a7 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setPrimalBound.xml @@ -0,0 +1,62 @@ + + + + + sym_setPrimalBound + Set the primal bound of the problem + + + + Calling Sequence + sym_setPrimalBound(bound) + + + + Description + + Set the primal bound of the loaded problem. + + + + + Arguments + + + + bound + The new primal bound for the problem + + + + + + + Return value + + Returns 0 + + + + + Examples + + sym_setPrimalBound(10) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setStrParam.xml b/help/en_US/Symphony Native Function/sym_setStrParam.xml new file mode 100644 index 0000000..09c5ea8 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setStrParam.xml @@ -0,0 +1,65 @@ + + + + + sym_setStrParam + This routine is used to set a string type parameter. + + + + Calling Sequence + sym_setStrParam(key,value) + + + + Description + + + + + + Arguments + + + + key + The name of the string type parameter to be set. Note: should be given within " " + + + value + New value of the corresponding string parameter. Note: should be given within " " + + + + + + + Return value + + Returns 0 if the parameter specified is set to the value mentioned and 0 if setting of the string parameter was unsuccessful due to invalid inputs + + + + + Examples + + status=sym_setStrParam("source_path","..") + + + + + Authors + + + Iswarya Hariharan + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setVarLower.xml b/help/en_US/Symphony Native Function/sym_setVarLower.xml new file mode 100644 index 0000000..1f24813 --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setVarLower.xml @@ -0,0 +1,66 @@ + + + + + sym_setVarLower + Set lower bound of a variable + + + + Calling Sequence + sym_setVarLower(index,newBound) + + + + Description + + This function changes the lower bound of a variable to a new value + + + + + Arguments + + + + index + Index of the variable to modify. Must be in {0,1,2,...n-1} where n is the number of variables in the problem + + + newBound + The new lower bound for the variable + + + + + + + Return value + + Returns 0 + + + + + Examples + + sym_setVarLower(2,-%inf) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setVarSoln.xml b/help/en_US/Symphony Native Function/sym_setVarSoln.xml new file mode 100644 index 0000000..5fe6f3c --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setVarSoln.xml @@ -0,0 +1,63 @@ + + + + + sym_setVarSoln + Set a solution for the problem + + + + Calling Sequence + sym_setVarSoln(solution) + + + + Description + + Sets a known solution for the problem. + This function fails if the solution entered does not satisfy all bounds or is worse than another currently known solution. + + + + + Arguments + + + + solution + Matrix containing solutions for the variables (must have size 1 row and number of columns equal to number of variables) + + + + + + + Return value + + Returns 0 + + + + + Examples + + sym_setVarSoln([1,2,3.2,4]) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_setVarUpper.xml b/help/en_US/Symphony Native Function/sym_setVarUpper.xml new file mode 100644 index 0000000..286c45f --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_setVarUpper.xml @@ -0,0 +1,66 @@ + + + + + sym_setVarUpper + Set upper bound of a variable + + + + Calling Sequence + sym_setVarUpper(index,newBound) + + + + Description + + This function changes the upper bound of a variable to a new value + + + + + Arguments + + + + index + Index of the variable to modify. Must be in {0,1,2,...n-1} where n is the number of variables in the problem + + + newBound + The new upper bound for the variable + + + + + + + Return value + + Returns 0 + + + + + Examples + + sym_setVarUpper(2,100) + + + + + Authors + + + Keyur Joshi + + + + + diff --git a/help/en_US/Symphony Native Function/sym_solve.xml b/help/en_US/Symphony Native Function/sym_solve.xml new file mode 100644 index 0000000..587b26a --- /dev/null +++ b/help/en_US/Symphony Native Function/sym_solve.xml @@ -0,0 +1,58 @@ + + + + + sym_solve + To solve the currently loaded MILP problem from scratch. + + + + Calling Sequence + sym_solve() + + + + Description + + This routine solves the currently loaded MILP problem from scratch. + It prints status of the problem solver to scilab console. + + + + + Arguments + + This function takes no arguments + + + + + Return value + + It returns 1 if it receives any return-value indicating an error message or 0 if it receives any return-value indicating a non-error message. + + + + + Examples + + status=sym_solve() + + + + + Authors + + + Sai Kiran Naragam + + + + + -- cgit