diff options
Diffstat (limited to 'help/en_US')
143 files changed, 10501 insertions, 0 deletions
diff --git a/help/en_US/build_help.sce b/help/en_US/build_help.sce new file mode 100644 index 0000000..493a4c5 --- /dev/null +++ b/help/en_US/build_help.sce @@ -0,0 +1,17 @@ +// Copyright (C) 2015 - IIT Bombay - FOSSEE +// +// Author: Harpreet Singh +// Organization: FOSSEE, IIT Bombay +// Email: harpreet.mertia@gmail.com +// This file must be used under the terms of the CeCILL. +// This source file is licensed as described in the file COPYING, which +// you should have received as part of this distribution. The terms +// are also available at +// http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt + +help_lang_dir = get_absolute_file_path('build_help.sce'); + +tbx_build_help(TOOLBOX_TITLE, help_lang_dir); + +clear help_lang_dir; + diff --git a/help/en_US/master_help.xml b/help/en_US/master_help.xml new file mode 100644 index 0000000..9e9d044 --- /dev/null +++ b/help/en_US/master_help.xml @@ -0,0 +1,137 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book [ +<!--Begin Entities--> +<!ENTITY ad63afa57bd1e41e497243af3416a7a96 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_addConstr.xml"> +<!ENTITY a8247e87aade4dbfbcfc9153f85bf8990 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_addVar.xml"> +<!ENTITY af05f97223726eec3eddcdaeb7913034b SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_close.xml"> +<!ENTITY a5f89e88d59f0487895c74eb903b8f420 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_deleteConstrs.xml"> +<!ENTITY a2ddebae154c914b0a110685d887f768a SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_deleteVars.xml"> +<!ENTITY a8c26d5b7b797136940b5f2716183b8f7 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getConstrActivity.xml"> +<!ENTITY a6c10c4c63fbc908142557556c7d6ae3c SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getConstrLower.xml"> +<!ENTITY a3f7dd3cd827416d5ade70fad38f09e39 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getConstrRange.xml"> +<!ENTITY a297e547e718608bdc60584192d7aa8da SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getConstrSense.xml"> +<!ENTITY a159870cd1d17f7605625c4c2ffea63b3 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getConstrUpper.xml"> +<!ENTITY a2698c5ff4d386b14d226498fcb915ab4 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getDblParam.xml"> +<!ENTITY a7cf6579fb9cfd79c4e6710bcc8a3c407 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getInfinity.xml"> +<!ENTITY ac7a9e00e4314b243faeded590d798496 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getIntParam.xml"> +<!ENTITY aeb8caae322c63cc2aa9c3afb5ab47e33 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getIterCount.xml"> +<!ENTITY a53be13b15cc84e0090de99ab0f21c69a SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getMatrix.xml"> +<!ENTITY adbcaca4ea8ebca8e190c3014e298dce0 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getNumConstr.xml"> +<!ENTITY ad9b780ba6aa53e4945273cd543b9ae00 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getNumElements.xml"> +<!ENTITY ae46439f289bd1a85a9061022194d969f SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getNumVar.xml"> +<!ENTITY af16b2d6adc9a030902fca655cf929458 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getObjCoeff.xml"> +<!ENTITY a7f4e13d42248eaa01eb018291fbeed8c SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getObjSense.xml"> +<!ENTITY a6e0822ca48da2799811f83a839606737 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getObjVal.xml"> +<!ENTITY aab889f249f83390381e3d41aa167c55c SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getPrimalBound.xml"> +<!ENTITY aebe86fa48ee09fb2157122078ae4570b SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getRhs.xml"> +<!ENTITY ad0bf592df7aeae5f419e0612d3c734c4 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getStatus.xml"> +<!ENTITY a0f674004b01faf9fd53355c563c07a87 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getStrParam.xml"> +<!ENTITY a4d20a2382e5540121ba8d04f139339b4 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getVarLower.xml"> +<!ENTITY a2f8c46472555ab851dd8ba7a5e3a781d SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getVarSoln.xml"> +<!ENTITY a475114ff3f1e1d93620d897ba32baf1d SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_getVarUpper.xml"> +<!ENTITY a37b1e125c6f5eec7b3c5dc1ea3692609 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_isAbandoned.xml"> +<!ENTITY aaf8a638121c8c4d363b938a96649674b SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_isBinary.xml"> +<!ENTITY aaf93eefab1947b754560bba197c76f04 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_isContinuous.xml"> +<!ENTITY ada402b7a7771c21c7c41401e683619e0 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_isEnvActive.xml"> +<!ENTITY af78b3f82e6a422b0e778631f421f404c SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_isInfeasible.xml"> +<!ENTITY a86bc80fec5de6f3ca0d70d572d53899f SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_isInteger.xml"> +<!ENTITY a801a0b05b108694afe2912523fb58b96 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_isIterLimitReached.xml"> +<!ENTITY a3da3e724f93be15664e051d940a284b1 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_isOptimal.xml"> +<!ENTITY a7a41409101a9f8d3123ce8b80284de7f SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_isTargetGapAchieved.xml"> +<!ENTITY a044d337acd155a0744a4b64ffa995e79 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_isTimeLimitReached.xml"> +<!ENTITY af3f068a2194dd5f6bd5974fb701c362d SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_loadMPS.xml"> +<!ENTITY a4e82ed5bca4822b39b85a5082ca4ecdb SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_loadProblem.xml"> +<!ENTITY afc3e9c55bcba964a8c3db4d50fdafc7b SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_loadProblemBasic.xml"> +<!ENTITY aabb2cfdb4a52dd37b4d973999b55503b SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_open.xml"> +<!ENTITY ae9b1c79d6dc7df29a19c03aba4799362 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_resetParams.xml"> +<!ENTITY a417a0991343caebac52cd2e29c5321e8 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setConstrLower.xml"> +<!ENTITY a7dc3b7f8cec19508c48857221d1f9d3d SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setConstrType.xml"> +<!ENTITY a80e54602881965b36417aae058acdbd4 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setConstrUpper.xml"> +<!ENTITY a9c03653658d9db46d6b1ceedb285f13b SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setContinuous.xml"> +<!ENTITY ab2a92099276a9820c12a9ccd4094df7f SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setDblParam.xml"> +<!ENTITY abd53842cbe394a800da795fd05b1df9d SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setIntParam.xml"> +<!ENTITY a2deda2e1b89aad11eb7c12006145141e SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setInteger.xml"> +<!ENTITY aac732b12f7e5e307624a5b3a831b788c SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setObjCoeff.xml"> +<!ENTITY a362d683f932821c69572bcafeafd2ba4 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setObjSense.xml"> +<!ENTITY a3c3ead6f32ca34d41748e3db79fbbd7e SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setPrimalBound.xml"> +<!ENTITY a057c61b992848035f0249f1fdb962d28 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setStrParam.xml"> +<!ENTITY a4edd542b73bd53f474bc4b3ba6b8f599 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setVarLower.xml"> +<!ENTITY a3bb05f0eb958e796e0474de1226c67c3 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setVarSoln.xml"> +<!ENTITY a33c0464a5b3293d925481bf20488ebc7 SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_setVarUpper.xml"> +<!ENTITY a9c0f2487231abebc5433bb8ae36d82ae SYSTEM "/home/harpreet/symphony_work/symphony/help/en_US/sym_solve.xml"> +<!--End Entities--> +]> +<book version="5.0-subset Scilab" xml:lang="en_US" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:html="http://www.w3.org/1999/xhtml" + xmlns:db="http://docbook.org/ns/docbook"> + <info xml:id='symphony_toolbox_manual'> + <title>Symphony Toolbox</title> + </info> + +<part xml:id='section_19f4f1e5726c01d683e8b82be0a7e910'> +<title>Symphony Toolbox</title> +&ad63afa57bd1e41e497243af3416a7a96; +&a8247e87aade4dbfbcfc9153f85bf8990; +&af05f97223726eec3eddcdaeb7913034b; +&a5f89e88d59f0487895c74eb903b8f420; +&a2ddebae154c914b0a110685d887f768a; +&a8c26d5b7b797136940b5f2716183b8f7; +&a6c10c4c63fbc908142557556c7d6ae3c; +&a3f7dd3cd827416d5ade70fad38f09e39; +&a297e547e718608bdc60584192d7aa8da; +&a159870cd1d17f7605625c4c2ffea63b3; +&a2698c5ff4d386b14d226498fcb915ab4; +&a7cf6579fb9cfd79c4e6710bcc8a3c407; +&ac7a9e00e4314b243faeded590d798496; +&aeb8caae322c63cc2aa9c3afb5ab47e33; +&a53be13b15cc84e0090de99ab0f21c69a; +&adbcaca4ea8ebca8e190c3014e298dce0; +&ad9b780ba6aa53e4945273cd543b9ae00; +&ae46439f289bd1a85a9061022194d969f; +&af16b2d6adc9a030902fca655cf929458; +&a7f4e13d42248eaa01eb018291fbeed8c; +&a6e0822ca48da2799811f83a839606737; +&aab889f249f83390381e3d41aa167c55c; +&aebe86fa48ee09fb2157122078ae4570b; +&ad0bf592df7aeae5f419e0612d3c734c4; +&a0f674004b01faf9fd53355c563c07a87; +&a4d20a2382e5540121ba8d04f139339b4; +&a2f8c46472555ab851dd8ba7a5e3a781d; +&a475114ff3f1e1d93620d897ba32baf1d; +&a37b1e125c6f5eec7b3c5dc1ea3692609; +&aaf8a638121c8c4d363b938a96649674b; +&aaf93eefab1947b754560bba197c76f04; +&ada402b7a7771c21c7c41401e683619e0; +&af78b3f82e6a422b0e778631f421f404c; +&a86bc80fec5de6f3ca0d70d572d53899f; +&a801a0b05b108694afe2912523fb58b96; +&a3da3e724f93be15664e051d940a284b1; +&a7a41409101a9f8d3123ce8b80284de7f; +&a044d337acd155a0744a4b64ffa995e79; +&af3f068a2194dd5f6bd5974fb701c362d; +&a4e82ed5bca4822b39b85a5082ca4ecdb; +&afc3e9c55bcba964a8c3db4d50fdafc7b; +&aabb2cfdb4a52dd37b4d973999b55503b; +&ae9b1c79d6dc7df29a19c03aba4799362; +&a417a0991343caebac52cd2e29c5321e8; +&a7dc3b7f8cec19508c48857221d1f9d3d; +&a80e54602881965b36417aae058acdbd4; +&a9c03653658d9db46d6b1ceedb285f13b; +&ab2a92099276a9820c12a9ccd4094df7f; +&abd53842cbe394a800da795fd05b1df9d; +&a2deda2e1b89aad11eb7c12006145141e; +&aac732b12f7e5e307624a5b3a831b788c; +&a362d683f932821c69572bcafeafd2ba4; +&a3c3ead6f32ca34d41748e3db79fbbd7e; +&a057c61b992848035f0249f1fdb962d28; +&a4edd542b73bd53f474bc4b3ba6b8f599; +&a3bb05f0eb958e796e0474de1226c67c3; +&a33c0464a5b3293d925481bf20488ebc7; +&a9c0f2487231abebc5433bb8ae36d82ae; +</part> +</book> diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS Binary files differnew file mode 100644 index 0000000..06f9d2a --- /dev/null +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB Binary files differnew file mode 100644 index 0000000..23b22c7 --- /dev/null +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/DOCS.TAB diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS b/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS Binary files differnew file mode 100644 index 0000000..656577e --- /dev/null +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/OFFSETS diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS b/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS Binary files differnew file mode 100644 index 0000000..148cf77 --- /dev/null +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/POSITIONS diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA b/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA new file mode 100644 index 0000000..096bb41 --- /dev/null +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/SCHEMA @@ -0,0 +1,2 @@ +JavaSearch 1.0 +TMAP bs=2048 rt=1 fl=-1 id1=536 id2=1 diff --git a/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP b/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP Binary files differnew file mode 100644 index 0000000..98648fa --- /dev/null +++ b/help/en_US/scilab_en_US_help/JavaHelpSearch/TMAP diff --git a/help/en_US/scilab_en_US_help/ScilabCaution.png b/help/en_US/scilab_en_US_help/ScilabCaution.png Binary files differnew file mode 100644 index 0000000..8edb56e --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabCaution.png diff --git a/help/en_US/scilab_en_US_help/ScilabEdit.png b/help/en_US/scilab_en_US_help/ScilabEdit.png Binary files differnew file mode 100644 index 0000000..e139988 --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabEdit.png diff --git a/help/en_US/scilab_en_US_help/ScilabExecute.png b/help/en_US/scilab_en_US_help/ScilabExecute.png Binary files differnew file mode 100644 index 0000000..4acd4b9 --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabExecute.png diff --git a/help/en_US/scilab_en_US_help/ScilabImportant.png b/help/en_US/scilab_en_US_help/ScilabImportant.png Binary files differnew file mode 100644 index 0000000..3b51020 --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabImportant.png diff --git a/help/en_US/scilab_en_US_help/ScilabNote.png b/help/en_US/scilab_en_US_help/ScilabNote.png Binary files differnew file mode 100644 index 0000000..ed46c3e --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabNote.png diff --git a/help/en_US/scilab_en_US_help/ScilabTip.png b/help/en_US/scilab_en_US_help/ScilabTip.png Binary files differnew file mode 100644 index 0000000..ed46c3e --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabTip.png diff --git a/help/en_US/scilab_en_US_help/ScilabWarning.png b/help/en_US/scilab_en_US_help/ScilabWarning.png Binary files differnew file mode 100644 index 0000000..8edb56e --- /dev/null +++ b/help/en_US/scilab_en_US_help/ScilabWarning.png diff --git a/help/en_US/scilab_en_US_help/c_code.css b/help/en_US/scilab_en_US_help/c_code.css new file mode 100644 index 0000000..948d2ee --- /dev/null +++ b/help/en_US/scilab_en_US_help/c_code.css @@ -0,0 +1,54 @@ +.ccomment { + font-style: italic; + color: #b22222 +} + +.cdefault { + font-style: normal; + color: #000000 +} + +.copenclose { + font-style: normal; + color: #000000 +} + +.coperator { + font-style: normal; + color: #000000 +} + +.cstring { + font-style: normal; + color: #a6557a +} + +.ctype { + font-style: normal; + color: #55a655 +} + +.cpreprocessor { + font-style: normal; + color: #9965a6 +} + +.cid { + font-style: normal; + color: #000000 +} + +.ckeyword { + font-style: normal; + color: #ad3ff2 +} + +.cmodifier { + font-style: normal; + color: #ad3ff2 +} + +.cnumber { + font-style: normal; + color: #008b8b +} diff --git a/help/en_US/scilab_en_US_help/index.html b/help/en_US/scilab_en_US_help/index.html new file mode 100644 index 0000000..3aaf941 --- /dev/null +++ b/help/en_US/scilab_en_US_help/index.html @@ -0,0 +1,283 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title></title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + + </td> + <td width="40%" class="center"> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + + + + + <br /><br /> + <h3 class="book-title">Symphony Toolbox</h3> +<ul class="list-part"><a name="symphony_toolbox_manual"></a><div class="info"></div> + +<li><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html" class="part">Symphony Toolbox</a> +<ul class="list-chapter"><li><a href="sym_addConstr.html" class="refentry">sym_addConstr</a> — <span class="refentry-description">Add a new constraint</span></li> + + + +<li><a href="sym_addVar.html" class="refentry">sym_addVar</a> — <span class="refentry-description">Add a new variable</span></li> + + + +<li><a href="sym_close.html" class="refentry">sym_close</a> — <span class="refentry-description">Close the Symphony environment</span></li> + + + +<li><a href="sym_deleteConstrs.html" class="refentry">sym_deleteConstrs</a> — <span class="refentry-description">This routine is used to delete rows from the original constraint matrix.</span></li> + + + +<li><a href="sym_deleteVars.html" class="refentry">sym_deleteVars</a> — <span class="refentry-description">This routine is used to delete columns from the original problem description.</span></li> + + + +<li><a href="sym_getConstrActivity.html" class="refentry">sym_getConstrActivity</a> — <span class="refentry-description">Get the activity of the constraints in the solution</span></li> + + + +<li><a href="sym_getConstrLower.html" class="refentry">sym_getConstrLower</a> — <span class="refentry-description">To get the lower bounds of the constraints.</span></li> + + + +<li><a href="sym_getConstrRange.html" class="refentry">sym_getConstrRange</a> — <span class="refentry-description">To to get the constraint ranges.</span></li> + + + +<li><a href="sym_getConstrSense.html" class="refentry">sym_getConstrSense</a> — <span class="refentry-description">To get the row senses.</span></li> + + + +<li><a href="sym_getConstrUpper.html" class="refentry">sym_getConstrUpper</a> — <span class="refentry-description">To get the upper bounds of the constraints.</span></li> + + + +<li><a href="sym_getDblParam.html" class="refentry">sym_getDblParam</a> — <span class="refentry-description">This routine is used to get the value of a double type parameter.</span></li> + + + +<li><a href="sym_getInfinity.html" class="refentry">sym_getInfinity</a> — <span class="refentry-description">Get Symphony's infinity value</span></li> + + + +<li><a href="sym_getIntParam.html" class="refentry">sym_getIntParam</a> — <span class="refentry-description">This routine is used to get the value of an integer type parameter.</span></li> + + + +<li><a href="sym_getIterCount.html" class="refentry">sym_getIterCount</a> — <span class="refentry-description">To get the number of the analyzed nodes of the branching tree after solving the problem.</span></li> + + + +<li><a href="sym_getMatrix.html" class="refentry">sym_getMatrix</a> — <span class="refentry-description">To get the constraint matrix.</span></li> + + + +<li><a href="sym_getNumConstr.html" class="refentry">sym_getNumConstr</a> — <span class="refentry-description">To get the number of the constraints of the current problem.</span></li> + + + +<li><a href="sym_getNumElements.html" class="refentry">sym_getNumElements</a> — <span class="refentry-description">To get the number of non-zero entries of the constraint matrix of the current problem.</span></li> + + + +<li><a href="sym_getNumVar.html" class="refentry">sym_getNumVar</a> — <span class="refentry-description">To get the number of the variables of the current problem.</span></li> + + + +<li><a href="sym_getObjCoeff.html" class="refentry">sym_getObjCoeff</a> — <span class="refentry-description">To get the objective vector.</span></li> + + + +<li><a href="sym_getObjSense.html" class="refentry">sym_getObjSense</a> — <span class="refentry-description">Get the objective sense</span></li> + + + +<li><a href="sym_getObjVal.html" class="refentry">sym_getObjVal</a> — <span class="refentry-description">Get the optimized objective value</span></li> + + + +<li><a href="sym_getPrimalBound.html" class="refentry">sym_getPrimalBound</a> — <span class="refentry-description">Get the primal bound of the problem</span></li> + + + +<li><a href="sym_getRhs.html" class="refentry">sym_getRhs</a> — <span class="refentry-description">To to get the right hand side vector(column vector).</span></li> + + + +<li><a href="sym_getStatus.html" class="refentry">sym_getStatus</a> — <span class="refentry-description">To get status of the problem solver.</span></li> + + + +<li><a href="sym_getStrParam.html" class="refentry">sym_getStrParam</a> — <span class="refentry-description">This routine is used to get the value of a string type parameter.</span></li> + + + +<li><a href="sym_getVarLower.html" class="refentry">sym_getVarLower</a> — <span class="refentry-description">To get the lower bounds of the variables.</span></li> + + + +<li><a href="sym_getVarSoln.html" class="refentry">sym_getVarSoln</a> — <span class="refentry-description">Get the solution for the problem</span></li> + + + +<li><a href="sym_getVarUpper.html" class="refentry">sym_getVarUpper</a> — <span class="refentry-description">To get the upper bounds of the variables.</span></li> + + + +<li><a href="sym_isAbandoned.html" class="refentry">sym_isAbandoned</a> — <span class="refentry-description">To check whether the problem was abandoned for some reason.</span></li> + + + +<li><a href="sym_isBinary.html" class="refentry">sym_isBinary</a> — <span class="refentry-description">Check if a variable is constrained to be binary</span></li> + + + +<li><a href="sym_isContinuous.html" class="refentry">sym_isContinuous</a> — <span class="refentry-description">Check if a variable is continuous</span></li> + + + +<li><a href="sym_isEnvActive.html" class="refentry">sym_isEnvActive</a> — <span class="refentry-description">Check if Symphony environment is active</span></li> + + + +<li><a href="sym_isInfeasible.html" class="refentry">sym_isInfeasible</a> — <span class="refentry-description">To check whether the problem was proven to be infeasible.</span></li> + + + +<li><a href="sym_isInteger.html" class="refentry">sym_isInteger</a> — <span class="refentry-description">Check if a variable is constrained to be an integer</span></li> + + + +<li><a href="sym_isIterLimitReached.html" class="refentry">sym_isIterLimitReached</a> — <span class="refentry-description">To know whether the iteration limit (node limit) was reached.</span></li> + + + +<li><a href="sym_isOptimal.html" class="refentry">sym_isOptimal</a> — <span class="refentry-description">To check whether the problem was solved to optimality.</span></li> + + + +<li><a href="sym_isTargetGapAchieved.html" class="refentry">sym_isTargetGapAchieved</a> — <span class="refentry-description">To know whether the target gap was reached.</span></li> + + + +<li><a href="sym_isTimeLimitReached.html" class="refentry">sym_isTimeLimitReached</a> — <span class="refentry-description">To know whether the time limit was reached.</span></li> + + + +<li><a href="sym_loadMPS.html" class="refentry">sym_loadMPS</a> — <span class="refentry-description">This routine is used to load an instance from an MPS file.</span></li> + + + +<li><a href="sym_loadProblem.html" class="refentry">sym_loadProblem</a> — <span class="refentry-description">Load a problem into Symphony</span></li> + + + +<li><a href="sym_loadProblemBasic.html" class="refentry">sym_loadProblemBasic</a> — <span class="refentry-description">Load a problem into Symphony (basic version)</span></li> + + + +<li><a href="sym_open.html" class="refentry">sym_open</a> — <span class="refentry-description">Open the Symphony environment</span></li> + + + +<li><a href="sym_resetParams.html" class="refentry">sym_resetParams</a> — <span class="refentry-description">This routine sets all the environment variables and parameters to their default values.</span></li> + + + +<li><a href="sym_setConstrLower.html" class="refentry">sym_setConstrLower</a> — <span class="refentry-description">Set the lower bound of a constraint</span></li> + + + +<li><a href="sym_setConstrType.html" class="refentry">sym_setConstrType</a> — <span class="refentry-description">Set the type of a constraint</span></li> + + + +<li><a href="sym_setConstrUpper.html" class="refentry">sym_setConstrUpper</a> — <span class="refentry-description">Set the upper bound of a constraint</span></li> + + + +<li><a href="sym_setContinuous.html" class="refentry">sym_setContinuous</a> — <span class="refentry-description">This routine is used to set the type of a variable to be continuous.</span></li> + + + +<li><a href="sym_setDblParam.html" class="refentry">sym_setDblParam</a> — <span class="refentry-description">This routine is used to set a double type parameter.</span></li> + + + +<li><a href="sym_setIntParam.html" class="refentry">sym_setIntParam</a> — <span class="refentry-description">This routine is used to set an integer type parameter.</span></li> + + + +<li><a href="sym_setInteger.html" class="refentry">sym_setInteger</a> — <span class="refentry-description">This routine is used to set the type of a variable to be integer.</span></li> + + + +<li><a href="sym_setObjCoeff.html" class="refentry">sym_setObjCoeff</a> — <span class="refentry-description">Set coefficient of a variable in the objective</span></li> + + + +<li><a href="sym_setObjSense.html" class="refentry">sym_setObjSense</a> — <span class="refentry-description">Set the objective sense</span></li> + + + +<li><a href="sym_setPrimalBound.html" class="refentry">sym_setPrimalBound</a> — <span class="refentry-description">Set the primal bound of the problem</span></li> + + + +<li><a href="sym_setStrParam.html" class="refentry">sym_setStrParam</a> — <span class="refentry-description">This routine is used to set a string type parameter.</span></li> + + + +<li><a href="sym_setVarLower.html" class="refentry">sym_setVarLower</a> — <span class="refentry-description">Set lower bound of a variable</span></li> + + + +<li><a href="sym_setVarSoln.html" class="refentry">sym_setVarSoln</a> — <span class="refentry-description">Set a solution for the problem</span></li> + + + +<li><a href="sym_setVarUpper.html" class="refentry">sym_setVarUpper</a> — <span class="refentry-description">Set upper bound of a variable</span></li> + + + +<li><a href="sym_solve.html" class="refentry">sym_solve</a> — <span class="refentry-description">To solve the currently loaded MILP problem from scratch.</span></li></ul></li></ul> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + + </td> + <td width="40%" class="center"> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/jhelpidx.xml b/help/en_US/scilab_en_US_help/jhelpidx.xml new file mode 100644 index 0000000..aa5a66e --- /dev/null +++ b/help/en_US/scilab_en_US_help/jhelpidx.xml @@ -0,0 +1,3 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE index PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Index Version 1.0//EN" "http://java.sun.com/products/javahelp/index_1_0.dtd"> +<index version="1.0"/>
\ No newline at end of file diff --git a/help/en_US/scilab_en_US_help/jhelpmap.jhm b/help/en_US/scilab_en_US_help/jhelpmap.jhm new file mode 100644 index 0000000..9e9f18d --- /dev/null +++ b/help/en_US/scilab_en_US_help/jhelpmap.jhm @@ -0,0 +1,64 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE map PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Map Version 1.0//EN" "http://java.sun.com/products/javahelp/map_1_0.dtd"> +<map version="1.0"> +<mapID target="index" url="index.html"/> +<mapID target="section_19f4f1e5726c01d683e8b82be0a7e910" url="section_19f4f1e5726c01d683e8b82be0a7e910.html"/> +<mapID target="sym_addConstr" url="sym_addConstr.html"/> +<mapID target="sym_addVar" url="sym_addVar.html"/> +<mapID target="sym_close" url="sym_close.html"/> +<mapID target="sym_deleteConstrs" url="sym_deleteConstrs.html"/> +<mapID target="sym_deleteVars" url="sym_deleteVars.html"/> +<mapID target="sym_getConstrActivity" url="sym_getConstrActivity.html"/> +<mapID target="sym_getConstrLower" url="sym_getConstrLower.html"/> +<mapID target="sym_getConstrRange" url="sym_getConstrRange.html"/> +<mapID target="sym_getConstrSense" url="sym_getConstrSense.html"/> +<mapID target="sym_getConstrUpper" url="sym_getConstrUpper.html"/> +<mapID target="sym_getDblParam" url="sym_getDblParam.html"/> +<mapID target="sym_getInfinity" url="sym_getInfinity.html"/> +<mapID target="sym_getIntParam" url="sym_getIntParam.html"/> +<mapID target="sym_getIterCount" url="sym_getIterCount.html"/> +<mapID target="sym_getMatrix" url="sym_getMatrix.html"/> +<mapID target="sym_getNumConstr" url="sym_getNumConstr.html"/> +<mapID target="sym_getNumElements" url="sym_getNumElements.html"/> +<mapID target="sym_getNumVar" url="sym_getNumVar.html"/> +<mapID target="sym_getObjCoeff" url="sym_getObjCoeff.html"/> +<mapID target="sym_getObjSense" url="sym_getObjSense.html"/> +<mapID target="sym_getObjVal" url="sym_getObjVal.html"/> +<mapID target="sym_getPrimalBound" url="sym_getPrimalBound.html"/> +<mapID target="sym_getRhs" url="sym_getRhs.html"/> +<mapID target="sym_getStatus" url="sym_getStatus.html"/> +<mapID target="sym_getStrParam" url="sym_getStrParam.html"/> +<mapID target="sym_getVarLower" url="sym_getVarLower.html"/> +<mapID target="sym_getVarSoln" url="sym_getVarSoln.html"/> +<mapID target="sym_getVarUpper" url="sym_getVarUpper.html"/> +<mapID target="sym_isAbandoned" url="sym_isAbandoned.html"/> +<mapID target="sym_isBinary" url="sym_isBinary.html"/> +<mapID target="sym_isContinuous" url="sym_isContinuous.html"/> +<mapID target="sym_isEnvActive" url="sym_isEnvActive.html"/> +<mapID target="sym_isInfeasible" url="sym_isInfeasible.html"/> +<mapID target="sym_isInteger" url="sym_isInteger.html"/> +<mapID target="sym_isIterLimitReached" url="sym_isIterLimitReached.html"/> +<mapID target="sym_isOptimal" url="sym_isOptimal.html"/> +<mapID target="sym_isTargetGapAchieved" url="sym_isTargetGapAchieved.html"/> +<mapID target="sym_isTimeLimitReached" url="sym_isTimeLimitReached.html"/> +<mapID target="sym_loadMPS" url="sym_loadMPS.html"/> +<mapID target="sym_loadProblem" url="sym_loadProblem.html"/> +<mapID target="sym_loadProblemBasic" url="sym_loadProblemBasic.html"/> +<mapID target="sym_open" url="sym_open.html"/> +<mapID target="sym_resetParams" url="sym_resetParams.html"/> +<mapID target="sym_setConstrLower" url="sym_setConstrLower.html"/> +<mapID target="sym_setConstrType" url="sym_setConstrType.html"/> +<mapID target="sym_setConstrUpper" url="sym_setConstrUpper.html"/> +<mapID target="sym_setContinuous" url="sym_setContinuous.html"/> +<mapID target="sym_setDblParam" url="sym_setDblParam.html"/> +<mapID target="sym_setIntParam" url="sym_setIntParam.html"/> +<mapID target="sym_setInteger" url="sym_setInteger.html"/> +<mapID target="sym_setObjCoeff" url="sym_setObjCoeff.html"/> +<mapID target="sym_setObjSense" url="sym_setObjSense.html"/> +<mapID target="sym_setPrimalBound" url="sym_setPrimalBound.html"/> +<mapID target="sym_setStrParam" url="sym_setStrParam.html"/> +<mapID target="sym_setVarLower" url="sym_setVarLower.html"/> +<mapID target="sym_setVarSoln" url="sym_setVarSoln.html"/> +<mapID target="sym_setVarUpper" url="sym_setVarUpper.html"/> +<mapID target="sym_solve" url="sym_solve.html"/> +</map>
\ No newline at end of file diff --git a/help/en_US/scilab_en_US_help/jhelpset.hs b/help/en_US/scilab_en_US_help/jhelpset.hs new file mode 100644 index 0000000..94c2e7e --- /dev/null +++ b/help/en_US/scilab_en_US_help/jhelpset.hs @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE helpset + PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp HelpSet Version 1.0//EN" "http://java.sun.com/products/javahelp/helpset_1_0.dtd"> +<helpset version="1.0"> +<title>Symphony Toolbox</title> +<maps> +<homeID>top</homeID> +<mapref location="jhelpmap.jhm"/> +</maps> +<view> +<name>TOC</name> +<label>Table Of Contents</label> +<type>javax.help.TOCView</type> +<data>jhelptoc.xml</data> +</view> +<view> +<name>Index</name> +<label>Index</label> +<type>javax.help.IndexView</type> +<data>jhelpidx.xml</data> +</view> +<view> +<name>Search</name> +<label>Search</label> +<type>javax.help.SearchView</type> +<data engine="com.sun.java.help.search.DefaultSearchEngine">JavaHelpSearch</data> +</view> +</helpset>
\ No newline at end of file diff --git a/help/en_US/scilab_en_US_help/jhelptoc.xml b/help/en_US/scilab_en_US_help/jhelptoc.xml new file mode 100644 index 0000000..4e62ec7 --- /dev/null +++ b/help/en_US/scilab_en_US_help/jhelptoc.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="utf-8" standalone="no"?> +<!DOCTYPE toc PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp TOC Version 1.0//EN" "http://java.sun.com/products/javahelp/toc_1_0.dtd"> +<toc version="1.0"> +<tocitem target="index" text="Symphony Toolbox"> +<tocitem target="section_19f4f1e5726c01d683e8b82be0a7e910" text="Symphony Toolbox"> +<tocitem target="sym_addConstr" text="sym_addConstr"/> +<tocitem target="sym_addVar" text="sym_addVar"/> +<tocitem target="sym_close" text="sym_close"/> +<tocitem target="sym_deleteConstrs" text="sym_deleteConstrs"/> +<tocitem target="sym_deleteVars" text="sym_deleteVars"/> +<tocitem target="sym_getConstrActivity" text="sym_getConstrActivity"/> +<tocitem target="sym_getConstrLower" text="sym_getConstrLower"/> +<tocitem target="sym_getConstrRange" text="sym_getConstrRange"/> +<tocitem target="sym_getConstrSense" text="sym_getConstrSense"/> +<tocitem target="sym_getConstrUpper" text="sym_getConstrUpper"/> +<tocitem target="sym_getDblParam" text="sym_getDblParam"/> +<tocitem target="sym_getInfinity" text="sym_getInfinity"/> +<tocitem target="sym_getIntParam" text="sym_getIntParam"/> +<tocitem target="sym_getIterCount" text="sym_getIterCount"/> +<tocitem target="sym_getMatrix" text="sym_getMatrix"/> +<tocitem target="sym_getNumConstr" text="sym_getNumConstr"/> +<tocitem target="sym_getNumElements" text="sym_getNumElements"/> +<tocitem target="sym_getNumVar" text="sym_getNumVar"/> +<tocitem target="sym_getObjCoeff" text="sym_getObjCoeff"/> +<tocitem target="sym_getObjSense" text="sym_getObjSense"/> +<tocitem target="sym_getObjVal" text="sym_getObjVal"/> +<tocitem target="sym_getPrimalBound" text="sym_getPrimalBound"/> +<tocitem target="sym_getRhs" text="sym_getRhs"/> +<tocitem target="sym_getStatus" text="sym_getStatus"/> +<tocitem target="sym_getStrParam" text="sym_getStrParam"/> +<tocitem target="sym_getVarLower" text="sym_getVarLower"/> +<tocitem target="sym_getVarSoln" text="sym_getVarSoln"/> +<tocitem target="sym_getVarUpper" text="sym_getVarUpper"/> +<tocitem target="sym_isAbandoned" text="sym_isAbandoned"/> +<tocitem target="sym_isBinary" text="sym_isBinary"/> +<tocitem target="sym_isContinuous" text="sym_isContinuous"/> +<tocitem target="sym_isEnvActive" text="sym_isEnvActive"/> +<tocitem target="sym_isInfeasible" text="sym_isInfeasible"/> +<tocitem target="sym_isInteger" text="sym_isInteger"/> +<tocitem target="sym_isIterLimitReached" text="sym_isIterLimitReached"/> +<tocitem target="sym_isOptimal" text="sym_isOptimal"/> +<tocitem target="sym_isTargetGapAchieved" text="sym_isTargetGapAchieved"/> +<tocitem target="sym_isTimeLimitReached" text="sym_isTimeLimitReached"/> +<tocitem target="sym_loadMPS" text="sym_loadMPS"/> +<tocitem target="sym_loadProblem" text="sym_loadProblem"/> +<tocitem target="sym_loadProblemBasic" text="sym_loadProblemBasic"/> +<tocitem target="sym_open" text="sym_open"/> +<tocitem target="sym_resetParams" text="sym_resetParams"/> +<tocitem target="sym_setConstrLower" text="sym_setConstrLower"/> +<tocitem target="sym_setConstrType" text="sym_setConstrType"/> +<tocitem target="sym_setConstrUpper" text="sym_setConstrUpper"/> +<tocitem target="sym_setContinuous" text="sym_setContinuous"/> +<tocitem target="sym_setDblParam" text="sym_setDblParam"/> +<tocitem target="sym_setIntParam" text="sym_setIntParam"/> +<tocitem target="sym_setInteger" text="sym_setInteger"/> +<tocitem target="sym_setObjCoeff" text="sym_setObjCoeff"/> +<tocitem target="sym_setObjSense" text="sym_setObjSense"/> +<tocitem target="sym_setPrimalBound" text="sym_setPrimalBound"/> +<tocitem target="sym_setStrParam" text="sym_setStrParam"/> +<tocitem target="sym_setVarLower" text="sym_setVarLower"/> +<tocitem target="sym_setVarSoln" text="sym_setVarSoln"/> +<tocitem target="sym_setVarUpper" text="sym_setVarUpper"/> +<tocitem target="sym_solve" text="sym_solve"/> +</tocitem> +</tocitem> +</toc>
\ No newline at end of file diff --git a/help/en_US/scilab_en_US_help/scilab_code.css b/help/en_US/scilab_en_US_help/scilab_code.css new file mode 100644 index 0000000..658f42e --- /dev/null +++ b/help/en_US/scilab_en_US_help/scilab_code.css @@ -0,0 +1,96 @@ +.scilabcomment { + font-style: italic; + color: #01a801 +} + +.scilabdefault { + font-style: normal; + color: #000000 +} + +.scilabspecial { + font-style: normal; + color: #ffaa00 +} + +.scilabconstants { + font-style: normal; + color: #da70d6 +} + +.scilaboperator { + font-style: normal; + color: #5c5c5c +} + +.scilabnumber { + font-style: normal; + color: #bc8f8f +} + +.scilabfkeyword { + font-style: normal; + color: #b01813 +} + +.scilabskeyword { + font-style: normal; + color: #a020f0 +} + +.scilabckeyword { + font-style: normal; + color: #5f9ea0 +} + +.scilabcommand { + font-style: normal; + color: #32b9b9 +} + +.scilabmacro { + font-style: normal; + color: #ae5cb0 +} + +a.scilabcommand { + font-style: normal; + text-decoration: underline; + color: #32b9b9 +} + +a.scilabmacro { + font-style: normal; + text-decoration: underline; + color: #ae5cb0 +} + +.scilabstring { + font-style: normal; + color: #bc8f8f +} + +.scilabid { + font-style: normal; + color: #000000 +} + +.scilabinputoutputargs { + font-weight: bold; + color: #834310 +} + +.scilabfunctionid { + font-weight: bold; + color: #000000 +} + +.scilabfield { + font-style: normal; + color: #aaaaaa +} + +.scilabopenclose { + font-style: normal; + color: #4a55db +} diff --git a/help/en_US/scilab_en_US_help/section_19f4f1e5726c01d683e8b82be0a7e910.html b/help/en_US/scilab_en_US_help/section_19f4f1e5726c01d683e8b82be0a7e910.html new file mode 100644 index 0000000..4d29dfb --- /dev/null +++ b/help/en_US/scilab_en_US_help/section_19f4f1e5726c01d683e8b82be0a7e910.html @@ -0,0 +1,283 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title></title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="index.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> Symphony Toolbox</span> + + <br /><br /> + <h3 class="title-part">Symphony Toolbox</h3> +<ul class="list-chapter"><li><a href="sym_addConstr.html" class="refentry">sym_addConstr</a> — <span class="refentry-description">Add a new constraint</span></li> + + + +<li><a href="sym_addVar.html" class="refentry">sym_addVar</a> — <span class="refentry-description">Add a new variable</span></li> + + + +<li><a href="sym_close.html" class="refentry">sym_close</a> — <span class="refentry-description">Close the Symphony environment</span></li> + + + +<li><a href="sym_deleteConstrs.html" class="refentry">sym_deleteConstrs</a> — <span class="refentry-description">This routine is used to delete rows from the original constraint matrix.</span></li> + + + +<li><a href="sym_deleteVars.html" class="refentry">sym_deleteVars</a> — <span class="refentry-description">This routine is used to delete columns from the original problem description.</span></li> + + + +<li><a href="sym_getConstrActivity.html" class="refentry">sym_getConstrActivity</a> — <span class="refentry-description">Get the activity of the constraints in the solution</span></li> + + + +<li><a href="sym_getConstrLower.html" class="refentry">sym_getConstrLower</a> — <span class="refentry-description">To get the lower bounds of the constraints.</span></li> + + + +<li><a href="sym_getConstrRange.html" class="refentry">sym_getConstrRange</a> — <span class="refentry-description">To to get the constraint ranges.</span></li> + + + +<li><a href="sym_getConstrSense.html" class="refentry">sym_getConstrSense</a> — <span class="refentry-description">To get the row senses.</span></li> + + + +<li><a href="sym_getConstrUpper.html" class="refentry">sym_getConstrUpper</a> — <span class="refentry-description">To get the upper bounds of the constraints.</span></li> + + + +<li><a href="sym_getDblParam.html" class="refentry">sym_getDblParam</a> — <span class="refentry-description">This routine is used to get the value of a double type parameter.</span></li> + + + +<li><a href="sym_getInfinity.html" class="refentry">sym_getInfinity</a> — <span class="refentry-description">Get Symphony's infinity value</span></li> + + + +<li><a href="sym_getIntParam.html" class="refentry">sym_getIntParam</a> — <span class="refentry-description">This routine is used to get the value of an integer type parameter.</span></li> + + + +<li><a href="sym_getIterCount.html" class="refentry">sym_getIterCount</a> — <span class="refentry-description">To get the number of the analyzed nodes of the branching tree after solving the problem.</span></li> + + + +<li><a href="sym_getMatrix.html" class="refentry">sym_getMatrix</a> — <span class="refentry-description">To get the constraint matrix.</span></li> + + + +<li><a href="sym_getNumConstr.html" class="refentry">sym_getNumConstr</a> — <span class="refentry-description">To get the number of the constraints of the current problem.</span></li> + + + +<li><a href="sym_getNumElements.html" class="refentry">sym_getNumElements</a> — <span class="refentry-description">To get the number of non-zero entries of the constraint matrix of the current problem.</span></li> + + + +<li><a href="sym_getNumVar.html" class="refentry">sym_getNumVar</a> — <span class="refentry-description">To get the number of the variables of the current problem.</span></li> + + + +<li><a href="sym_getObjCoeff.html" class="refentry">sym_getObjCoeff</a> — <span class="refentry-description">To get the objective vector.</span></li> + + + +<li><a href="sym_getObjSense.html" class="refentry">sym_getObjSense</a> — <span class="refentry-description">Get the objective sense</span></li> + + + +<li><a href="sym_getObjVal.html" class="refentry">sym_getObjVal</a> — <span class="refentry-description">Get the optimized objective value</span></li> + + + +<li><a href="sym_getPrimalBound.html" class="refentry">sym_getPrimalBound</a> — <span class="refentry-description">Get the primal bound of the problem</span></li> + + + +<li><a href="sym_getRhs.html" class="refentry">sym_getRhs</a> — <span class="refentry-description">To to get the right hand side vector(column vector).</span></li> + + + +<li><a href="sym_getStatus.html" class="refentry">sym_getStatus</a> — <span class="refentry-description">To get status of the problem solver.</span></li> + + + +<li><a href="sym_getStrParam.html" class="refentry">sym_getStrParam</a> — <span class="refentry-description">This routine is used to get the value of a string type parameter.</span></li> + + + +<li><a href="sym_getVarLower.html" class="refentry">sym_getVarLower</a> — <span class="refentry-description">To get the lower bounds of the variables.</span></li> + + + +<li><a href="sym_getVarSoln.html" class="refentry">sym_getVarSoln</a> — <span class="refentry-description">Get the solution for the problem</span></li> + + + +<li><a href="sym_getVarUpper.html" class="refentry">sym_getVarUpper</a> — <span class="refentry-description">To get the upper bounds of the variables.</span></li> + + + +<li><a href="sym_isAbandoned.html" class="refentry">sym_isAbandoned</a> — <span class="refentry-description">To check whether the problem was abandoned for some reason.</span></li> + + + +<li><a href="sym_isBinary.html" class="refentry">sym_isBinary</a> — <span class="refentry-description">Check if a variable is constrained to be binary</span></li> + + + +<li><a href="sym_isContinuous.html" class="refentry">sym_isContinuous</a> — <span class="refentry-description">Check if a variable is continuous</span></li> + + + +<li><a href="sym_isEnvActive.html" class="refentry">sym_isEnvActive</a> — <span class="refentry-description">Check if Symphony environment is active</span></li> + + + +<li><a href="sym_isInfeasible.html" class="refentry">sym_isInfeasible</a> — <span class="refentry-description">To check whether the problem was proven to be infeasible.</span></li> + + + +<li><a href="sym_isInteger.html" class="refentry">sym_isInteger</a> — <span class="refentry-description">Check if a variable is constrained to be an integer</span></li> + + + +<li><a href="sym_isIterLimitReached.html" class="refentry">sym_isIterLimitReached</a> — <span class="refentry-description">To know whether the iteration limit (node limit) was reached.</span></li> + + + +<li><a href="sym_isOptimal.html" class="refentry">sym_isOptimal</a> — <span class="refentry-description">To check whether the problem was solved to optimality.</span></li> + + + +<li><a href="sym_isTargetGapAchieved.html" class="refentry">sym_isTargetGapAchieved</a> — <span class="refentry-description">To know whether the target gap was reached.</span></li> + + + +<li><a href="sym_isTimeLimitReached.html" class="refentry">sym_isTimeLimitReached</a> — <span class="refentry-description">To know whether the time limit was reached.</span></li> + + + +<li><a href="sym_loadMPS.html" class="refentry">sym_loadMPS</a> — <span class="refentry-description">This routine is used to load an instance from an MPS file.</span></li> + + + +<li><a href="sym_loadProblem.html" class="refentry">sym_loadProblem</a> — <span class="refentry-description">Load a problem into Symphony</span></li> + + + +<li><a href="sym_loadProblemBasic.html" class="refentry">sym_loadProblemBasic</a> — <span class="refentry-description">Load a problem into Symphony (basic version)</span></li> + + + +<li><a href="sym_open.html" class="refentry">sym_open</a> — <span class="refentry-description">Open the Symphony environment</span></li> + + + +<li><a href="sym_resetParams.html" class="refentry">sym_resetParams</a> — <span class="refentry-description">This routine sets all the environment variables and parameters to their default values.</span></li> + + + +<li><a href="sym_setConstrLower.html" class="refentry">sym_setConstrLower</a> — <span class="refentry-description">Set the lower bound of a constraint</span></li> + + + +<li><a href="sym_setConstrType.html" class="refentry">sym_setConstrType</a> — <span class="refentry-description">Set the type of a constraint</span></li> + + + +<li><a href="sym_setConstrUpper.html" class="refentry">sym_setConstrUpper</a> — <span class="refentry-description">Set the upper bound of a constraint</span></li> + + + +<li><a href="sym_setContinuous.html" class="refentry">sym_setContinuous</a> — <span class="refentry-description">This routine is used to set the type of a variable to be continuous.</span></li> + + + +<li><a href="sym_setDblParam.html" class="refentry">sym_setDblParam</a> — <span class="refentry-description">This routine is used to set a double type parameter.</span></li> + + + +<li><a href="sym_setIntParam.html" class="refentry">sym_setIntParam</a> — <span class="refentry-description">This routine is used to set an integer type parameter.</span></li> + + + +<li><a href="sym_setInteger.html" class="refentry">sym_setInteger</a> — <span class="refentry-description">This routine is used to set the type of a variable to be integer.</span></li> + + + +<li><a href="sym_setObjCoeff.html" class="refentry">sym_setObjCoeff</a> — <span class="refentry-description">Set coefficient of a variable in the objective</span></li> + + + +<li><a href="sym_setObjSense.html" class="refentry">sym_setObjSense</a> — <span class="refentry-description">Set the objective sense</span></li> + + + +<li><a href="sym_setPrimalBound.html" class="refentry">sym_setPrimalBound</a> — <span class="refentry-description">Set the primal bound of the problem</span></li> + + + +<li><a href="sym_setStrParam.html" class="refentry">sym_setStrParam</a> — <span class="refentry-description">This routine is used to set a string type parameter.</span></li> + + + +<li><a href="sym_setVarLower.html" class="refentry">sym_setVarLower</a> — <span class="refentry-description">Set lower bound of a variable</span></li> + + + +<li><a href="sym_setVarSoln.html" class="refentry">sym_setVarSoln</a> — <span class="refentry-description">Set a solution for the problem</span></li> + + + +<li><a href="sym_setVarUpper.html" class="refentry">sym_setVarUpper</a> — <span class="refentry-description">Set upper bound of a variable</span></li> + + + +<li><a href="sym_solve.html" class="refentry">sym_solve</a> — <span class="refentry-description">To solve the currently loaded MILP problem from scratch.</span></li></ul> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="index.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/section_55504497b369d5dbff95caa93ffab1ff.html b/help/en_US/scilab_en_US_help/section_55504497b369d5dbff95caa93ffab1ff.html new file mode 100644 index 0000000..4d29dfb --- /dev/null +++ b/help/en_US/scilab_en_US_help/section_55504497b369d5dbff95caa93ffab1ff.html @@ -0,0 +1,283 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title></title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="index.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> Symphony Toolbox</span> + + <br /><br /> + <h3 class="title-part">Symphony Toolbox</h3> +<ul class="list-chapter"><li><a href="sym_addConstr.html" class="refentry">sym_addConstr</a> — <span class="refentry-description">Add a new constraint</span></li> + + + +<li><a href="sym_addVar.html" class="refentry">sym_addVar</a> — <span class="refentry-description">Add a new variable</span></li> + + + +<li><a href="sym_close.html" class="refentry">sym_close</a> — <span class="refentry-description">Close the Symphony environment</span></li> + + + +<li><a href="sym_deleteConstrs.html" class="refentry">sym_deleteConstrs</a> — <span class="refentry-description">This routine is used to delete rows from the original constraint matrix.</span></li> + + + +<li><a href="sym_deleteVars.html" class="refentry">sym_deleteVars</a> — <span class="refentry-description">This routine is used to delete columns from the original problem description.</span></li> + + + +<li><a href="sym_getConstrActivity.html" class="refentry">sym_getConstrActivity</a> — <span class="refentry-description">Get the activity of the constraints in the solution</span></li> + + + +<li><a href="sym_getConstrLower.html" class="refentry">sym_getConstrLower</a> — <span class="refentry-description">To get the lower bounds of the constraints.</span></li> + + + +<li><a href="sym_getConstrRange.html" class="refentry">sym_getConstrRange</a> — <span class="refentry-description">To to get the constraint ranges.</span></li> + + + +<li><a href="sym_getConstrSense.html" class="refentry">sym_getConstrSense</a> — <span class="refentry-description">To get the row senses.</span></li> + + + +<li><a href="sym_getConstrUpper.html" class="refentry">sym_getConstrUpper</a> — <span class="refentry-description">To get the upper bounds of the constraints.</span></li> + + + +<li><a href="sym_getDblParam.html" class="refentry">sym_getDblParam</a> — <span class="refentry-description">This routine is used to get the value of a double type parameter.</span></li> + + + +<li><a href="sym_getInfinity.html" class="refentry">sym_getInfinity</a> — <span class="refentry-description">Get Symphony's infinity value</span></li> + + + +<li><a href="sym_getIntParam.html" class="refentry">sym_getIntParam</a> — <span class="refentry-description">This routine is used to get the value of an integer type parameter.</span></li> + + + +<li><a href="sym_getIterCount.html" class="refentry">sym_getIterCount</a> — <span class="refentry-description">To get the number of the analyzed nodes of the branching tree after solving the problem.</span></li> + + + +<li><a href="sym_getMatrix.html" class="refentry">sym_getMatrix</a> — <span class="refentry-description">To get the constraint matrix.</span></li> + + + +<li><a href="sym_getNumConstr.html" class="refentry">sym_getNumConstr</a> — <span class="refentry-description">To get the number of the constraints of the current problem.</span></li> + + + +<li><a href="sym_getNumElements.html" class="refentry">sym_getNumElements</a> — <span class="refentry-description">To get the number of non-zero entries of the constraint matrix of the current problem.</span></li> + + + +<li><a href="sym_getNumVar.html" class="refentry">sym_getNumVar</a> — <span class="refentry-description">To get the number of the variables of the current problem.</span></li> + + + +<li><a href="sym_getObjCoeff.html" class="refentry">sym_getObjCoeff</a> — <span class="refentry-description">To get the objective vector.</span></li> + + + +<li><a href="sym_getObjSense.html" class="refentry">sym_getObjSense</a> — <span class="refentry-description">Get the objective sense</span></li> + + + +<li><a href="sym_getObjVal.html" class="refentry">sym_getObjVal</a> — <span class="refentry-description">Get the optimized objective value</span></li> + + + +<li><a href="sym_getPrimalBound.html" class="refentry">sym_getPrimalBound</a> — <span class="refentry-description">Get the primal bound of the problem</span></li> + + + +<li><a href="sym_getRhs.html" class="refentry">sym_getRhs</a> — <span class="refentry-description">To to get the right hand side vector(column vector).</span></li> + + + +<li><a href="sym_getStatus.html" class="refentry">sym_getStatus</a> — <span class="refentry-description">To get status of the problem solver.</span></li> + + + +<li><a href="sym_getStrParam.html" class="refentry">sym_getStrParam</a> — <span class="refentry-description">This routine is used to get the value of a string type parameter.</span></li> + + + +<li><a href="sym_getVarLower.html" class="refentry">sym_getVarLower</a> — <span class="refentry-description">To get the lower bounds of the variables.</span></li> + + + +<li><a href="sym_getVarSoln.html" class="refentry">sym_getVarSoln</a> — <span class="refentry-description">Get the solution for the problem</span></li> + + + +<li><a href="sym_getVarUpper.html" class="refentry">sym_getVarUpper</a> — <span class="refentry-description">To get the upper bounds of the variables.</span></li> + + + +<li><a href="sym_isAbandoned.html" class="refentry">sym_isAbandoned</a> — <span class="refentry-description">To check whether the problem was abandoned for some reason.</span></li> + + + +<li><a href="sym_isBinary.html" class="refentry">sym_isBinary</a> — <span class="refentry-description">Check if a variable is constrained to be binary</span></li> + + + +<li><a href="sym_isContinuous.html" class="refentry">sym_isContinuous</a> — <span class="refentry-description">Check if a variable is continuous</span></li> + + + +<li><a href="sym_isEnvActive.html" class="refentry">sym_isEnvActive</a> — <span class="refentry-description">Check if Symphony environment is active</span></li> + + + +<li><a href="sym_isInfeasible.html" class="refentry">sym_isInfeasible</a> — <span class="refentry-description">To check whether the problem was proven to be infeasible.</span></li> + + + +<li><a href="sym_isInteger.html" class="refentry">sym_isInteger</a> — <span class="refentry-description">Check if a variable is constrained to be an integer</span></li> + + + +<li><a href="sym_isIterLimitReached.html" class="refentry">sym_isIterLimitReached</a> — <span class="refentry-description">To know whether the iteration limit (node limit) was reached.</span></li> + + + +<li><a href="sym_isOptimal.html" class="refentry">sym_isOptimal</a> — <span class="refentry-description">To check whether the problem was solved to optimality.</span></li> + + + +<li><a href="sym_isTargetGapAchieved.html" class="refentry">sym_isTargetGapAchieved</a> — <span class="refentry-description">To know whether the target gap was reached.</span></li> + + + +<li><a href="sym_isTimeLimitReached.html" class="refentry">sym_isTimeLimitReached</a> — <span class="refentry-description">To know whether the time limit was reached.</span></li> + + + +<li><a href="sym_loadMPS.html" class="refentry">sym_loadMPS</a> — <span class="refentry-description">This routine is used to load an instance from an MPS file.</span></li> + + + +<li><a href="sym_loadProblem.html" class="refentry">sym_loadProblem</a> — <span class="refentry-description">Load a problem into Symphony</span></li> + + + +<li><a href="sym_loadProblemBasic.html" class="refentry">sym_loadProblemBasic</a> — <span class="refentry-description">Load a problem into Symphony (basic version)</span></li> + + + +<li><a href="sym_open.html" class="refentry">sym_open</a> — <span class="refentry-description">Open the Symphony environment</span></li> + + + +<li><a href="sym_resetParams.html" class="refentry">sym_resetParams</a> — <span class="refentry-description">This routine sets all the environment variables and parameters to their default values.</span></li> + + + +<li><a href="sym_setConstrLower.html" class="refentry">sym_setConstrLower</a> — <span class="refentry-description">Set the lower bound of a constraint</span></li> + + + +<li><a href="sym_setConstrType.html" class="refentry">sym_setConstrType</a> — <span class="refentry-description">Set the type of a constraint</span></li> + + + +<li><a href="sym_setConstrUpper.html" class="refentry">sym_setConstrUpper</a> — <span class="refentry-description">Set the upper bound of a constraint</span></li> + + + +<li><a href="sym_setContinuous.html" class="refentry">sym_setContinuous</a> — <span class="refentry-description">This routine is used to set the type of a variable to be continuous.</span></li> + + + +<li><a href="sym_setDblParam.html" class="refentry">sym_setDblParam</a> — <span class="refentry-description">This routine is used to set a double type parameter.</span></li> + + + +<li><a href="sym_setIntParam.html" class="refentry">sym_setIntParam</a> — <span class="refentry-description">This routine is used to set an integer type parameter.</span></li> + + + +<li><a href="sym_setInteger.html" class="refentry">sym_setInteger</a> — <span class="refentry-description">This routine is used to set the type of a variable to be integer.</span></li> + + + +<li><a href="sym_setObjCoeff.html" class="refentry">sym_setObjCoeff</a> — <span class="refentry-description">Set coefficient of a variable in the objective</span></li> + + + +<li><a href="sym_setObjSense.html" class="refentry">sym_setObjSense</a> — <span class="refentry-description">Set the objective sense</span></li> + + + +<li><a href="sym_setPrimalBound.html" class="refentry">sym_setPrimalBound</a> — <span class="refentry-description">Set the primal bound of the problem</span></li> + + + +<li><a href="sym_setStrParam.html" class="refentry">sym_setStrParam</a> — <span class="refentry-description">This routine is used to set a string type parameter.</span></li> + + + +<li><a href="sym_setVarLower.html" class="refentry">sym_setVarLower</a> — <span class="refentry-description">Set lower bound of a variable</span></li> + + + +<li><a href="sym_setVarSoln.html" class="refentry">sym_setVarSoln</a> — <span class="refentry-description">Set a solution for the problem</span></li> + + + +<li><a href="sym_setVarUpper.html" class="refentry">sym_setVarUpper</a> — <span class="refentry-description">Set upper bound of a variable</span></li> + + + +<li><a href="sym_solve.html" class="refentry">sym_solve</a> — <span class="refentry-description">To solve the currently loaded MILP problem from scratch.</span></li></ul> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="index.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/section_bee7f332db33892256e9f1f82b7d348f.html b/help/en_US/scilab_en_US_help/section_bee7f332db33892256e9f1f82b7d348f.html new file mode 100644 index 0000000..4d29dfb --- /dev/null +++ b/help/en_US/scilab_en_US_help/section_bee7f332db33892256e9f1f82b7d348f.html @@ -0,0 +1,283 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title></title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="index.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> Symphony Toolbox</span> + + <br /><br /> + <h3 class="title-part">Symphony Toolbox</h3> +<ul class="list-chapter"><li><a href="sym_addConstr.html" class="refentry">sym_addConstr</a> — <span class="refentry-description">Add a new constraint</span></li> + + + +<li><a href="sym_addVar.html" class="refentry">sym_addVar</a> — <span class="refentry-description">Add a new variable</span></li> + + + +<li><a href="sym_close.html" class="refentry">sym_close</a> — <span class="refentry-description">Close the Symphony environment</span></li> + + + +<li><a href="sym_deleteConstrs.html" class="refentry">sym_deleteConstrs</a> — <span class="refentry-description">This routine is used to delete rows from the original constraint matrix.</span></li> + + + +<li><a href="sym_deleteVars.html" class="refentry">sym_deleteVars</a> — <span class="refentry-description">This routine is used to delete columns from the original problem description.</span></li> + + + +<li><a href="sym_getConstrActivity.html" class="refentry">sym_getConstrActivity</a> — <span class="refentry-description">Get the activity of the constraints in the solution</span></li> + + + +<li><a href="sym_getConstrLower.html" class="refentry">sym_getConstrLower</a> — <span class="refentry-description">To get the lower bounds of the constraints.</span></li> + + + +<li><a href="sym_getConstrRange.html" class="refentry">sym_getConstrRange</a> — <span class="refentry-description">To to get the constraint ranges.</span></li> + + + +<li><a href="sym_getConstrSense.html" class="refentry">sym_getConstrSense</a> — <span class="refentry-description">To get the row senses.</span></li> + + + +<li><a href="sym_getConstrUpper.html" class="refentry">sym_getConstrUpper</a> — <span class="refentry-description">To get the upper bounds of the constraints.</span></li> + + + +<li><a href="sym_getDblParam.html" class="refentry">sym_getDblParam</a> — <span class="refentry-description">This routine is used to get the value of a double type parameter.</span></li> + + + +<li><a href="sym_getInfinity.html" class="refentry">sym_getInfinity</a> — <span class="refentry-description">Get Symphony's infinity value</span></li> + + + +<li><a href="sym_getIntParam.html" class="refentry">sym_getIntParam</a> — <span class="refentry-description">This routine is used to get the value of an integer type parameter.</span></li> + + + +<li><a href="sym_getIterCount.html" class="refentry">sym_getIterCount</a> — <span class="refentry-description">To get the number of the analyzed nodes of the branching tree after solving the problem.</span></li> + + + +<li><a href="sym_getMatrix.html" class="refentry">sym_getMatrix</a> — <span class="refentry-description">To get the constraint matrix.</span></li> + + + +<li><a href="sym_getNumConstr.html" class="refentry">sym_getNumConstr</a> — <span class="refentry-description">To get the number of the constraints of the current problem.</span></li> + + + +<li><a href="sym_getNumElements.html" class="refentry">sym_getNumElements</a> — <span class="refentry-description">To get the number of non-zero entries of the constraint matrix of the current problem.</span></li> + + + +<li><a href="sym_getNumVar.html" class="refentry">sym_getNumVar</a> — <span class="refentry-description">To get the number of the variables of the current problem.</span></li> + + + +<li><a href="sym_getObjCoeff.html" class="refentry">sym_getObjCoeff</a> — <span class="refentry-description">To get the objective vector.</span></li> + + + +<li><a href="sym_getObjSense.html" class="refentry">sym_getObjSense</a> — <span class="refentry-description">Get the objective sense</span></li> + + + +<li><a href="sym_getObjVal.html" class="refentry">sym_getObjVal</a> — <span class="refentry-description">Get the optimized objective value</span></li> + + + +<li><a href="sym_getPrimalBound.html" class="refentry">sym_getPrimalBound</a> — <span class="refentry-description">Get the primal bound of the problem</span></li> + + + +<li><a href="sym_getRhs.html" class="refentry">sym_getRhs</a> — <span class="refentry-description">To to get the right hand side vector(column vector).</span></li> + + + +<li><a href="sym_getStatus.html" class="refentry">sym_getStatus</a> — <span class="refentry-description">To get status of the problem solver.</span></li> + + + +<li><a href="sym_getStrParam.html" class="refentry">sym_getStrParam</a> — <span class="refentry-description">This routine is used to get the value of a string type parameter.</span></li> + + + +<li><a href="sym_getVarLower.html" class="refentry">sym_getVarLower</a> — <span class="refentry-description">To get the lower bounds of the variables.</span></li> + + + +<li><a href="sym_getVarSoln.html" class="refentry">sym_getVarSoln</a> — <span class="refentry-description">Get the solution for the problem</span></li> + + + +<li><a href="sym_getVarUpper.html" class="refentry">sym_getVarUpper</a> — <span class="refentry-description">To get the upper bounds of the variables.</span></li> + + + +<li><a href="sym_isAbandoned.html" class="refentry">sym_isAbandoned</a> — <span class="refentry-description">To check whether the problem was abandoned for some reason.</span></li> + + + +<li><a href="sym_isBinary.html" class="refentry">sym_isBinary</a> — <span class="refentry-description">Check if a variable is constrained to be binary</span></li> + + + +<li><a href="sym_isContinuous.html" class="refentry">sym_isContinuous</a> — <span class="refentry-description">Check if a variable is continuous</span></li> + + + +<li><a href="sym_isEnvActive.html" class="refentry">sym_isEnvActive</a> — <span class="refentry-description">Check if Symphony environment is active</span></li> + + + +<li><a href="sym_isInfeasible.html" class="refentry">sym_isInfeasible</a> — <span class="refentry-description">To check whether the problem was proven to be infeasible.</span></li> + + + +<li><a href="sym_isInteger.html" class="refentry">sym_isInteger</a> — <span class="refentry-description">Check if a variable is constrained to be an integer</span></li> + + + +<li><a href="sym_isIterLimitReached.html" class="refentry">sym_isIterLimitReached</a> — <span class="refentry-description">To know whether the iteration limit (node limit) was reached.</span></li> + + + +<li><a href="sym_isOptimal.html" class="refentry">sym_isOptimal</a> — <span class="refentry-description">To check whether the problem was solved to optimality.</span></li> + + + +<li><a href="sym_isTargetGapAchieved.html" class="refentry">sym_isTargetGapAchieved</a> — <span class="refentry-description">To know whether the target gap was reached.</span></li> + + + +<li><a href="sym_isTimeLimitReached.html" class="refentry">sym_isTimeLimitReached</a> — <span class="refentry-description">To know whether the time limit was reached.</span></li> + + + +<li><a href="sym_loadMPS.html" class="refentry">sym_loadMPS</a> — <span class="refentry-description">This routine is used to load an instance from an MPS file.</span></li> + + + +<li><a href="sym_loadProblem.html" class="refentry">sym_loadProblem</a> — <span class="refentry-description">Load a problem into Symphony</span></li> + + + +<li><a href="sym_loadProblemBasic.html" class="refentry">sym_loadProblemBasic</a> — <span class="refentry-description">Load a problem into Symphony (basic version)</span></li> + + + +<li><a href="sym_open.html" class="refentry">sym_open</a> — <span class="refentry-description">Open the Symphony environment</span></li> + + + +<li><a href="sym_resetParams.html" class="refentry">sym_resetParams</a> — <span class="refentry-description">This routine sets all the environment variables and parameters to their default values.</span></li> + + + +<li><a href="sym_setConstrLower.html" class="refentry">sym_setConstrLower</a> — <span class="refentry-description">Set the lower bound of a constraint</span></li> + + + +<li><a href="sym_setConstrType.html" class="refentry">sym_setConstrType</a> — <span class="refentry-description">Set the type of a constraint</span></li> + + + +<li><a href="sym_setConstrUpper.html" class="refentry">sym_setConstrUpper</a> — <span class="refentry-description">Set the upper bound of a constraint</span></li> + + + +<li><a href="sym_setContinuous.html" class="refentry">sym_setContinuous</a> — <span class="refentry-description">This routine is used to set the type of a variable to be continuous.</span></li> + + + +<li><a href="sym_setDblParam.html" class="refentry">sym_setDblParam</a> — <span class="refentry-description">This routine is used to set a double type parameter.</span></li> + + + +<li><a href="sym_setIntParam.html" class="refentry">sym_setIntParam</a> — <span class="refentry-description">This routine is used to set an integer type parameter.</span></li> + + + +<li><a href="sym_setInteger.html" class="refentry">sym_setInteger</a> — <span class="refentry-description">This routine is used to set the type of a variable to be integer.</span></li> + + + +<li><a href="sym_setObjCoeff.html" class="refentry">sym_setObjCoeff</a> — <span class="refentry-description">Set coefficient of a variable in the objective</span></li> + + + +<li><a href="sym_setObjSense.html" class="refentry">sym_setObjSense</a> — <span class="refentry-description">Set the objective sense</span></li> + + + +<li><a href="sym_setPrimalBound.html" class="refentry">sym_setPrimalBound</a> — <span class="refentry-description">Set the primal bound of the problem</span></li> + + + +<li><a href="sym_setStrParam.html" class="refentry">sym_setStrParam</a> — <span class="refentry-description">This routine is used to set a string type parameter.</span></li> + + + +<li><a href="sym_setVarLower.html" class="refentry">sym_setVarLower</a> — <span class="refentry-description">Set lower bound of a variable</span></li> + + + +<li><a href="sym_setVarSoln.html" class="refentry">sym_setVarSoln</a> — <span class="refentry-description">Set a solution for the problem</span></li> + + + +<li><a href="sym_setVarUpper.html" class="refentry">sym_setVarUpper</a> — <span class="refentry-description">Set upper bound of a variable</span></li> + + + +<li><a href="sym_solve.html" class="refentry">sym_solve</a> — <span class="refentry-description">To solve the currently loaded MILP problem from scratch.</span></li></ul> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="index.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/style.css b/help/en_US/scilab_en_US_help/style.css new file mode 100644 index 0000000..0fe8923 --- /dev/null +++ b/help/en_US/scilab_en_US_help/style.css @@ -0,0 +1,350 @@ +body { + color:#000000; + background-color:#ffffff; + font-family:sans-serif; + font-size:100%; + margin:5px; + padding:0; + background : url("/img/body.png"); + background-repeat : repeat-x; +} + +.para { + padding-left: 10px; +} + +.refname { + color: #ff6c0a; +} +.refpurpose { + font-size: 110%; +} + +.synopsis { + border: 1px solid black; + width:80%; + padding: 0.5em; +} + +.editbar { + text-align: right; +} + +.term { + color:#800000; + font-size:100%; +} + +h3 { + color: #000063; + font-weight: bold; + font-size:130%; + margin-bottom: 10px; +} + +.programlisting { + font-family: monospace; + font-size: 100%; + background-color:#EEEEFF; + border-color:#CCCCCC; + border-style:solid; + border-width:2px medium; + width:80%; + color:#333333; + line-height:120%; + padding:10px; +} + +.literal { + font-family: monospace; + font-size: 100%; +} + +.option { + font-family: monospace; + font-style: italic; + font-size: 100%; +} + +.command { + font-family: monospace; + font-size: 100%; + color: #32b9b9; +} + +.function { + font-family: monospace; + font-size: 100%; + color: #32b9b9; +} + +.varname { + font-family: monospace; + font-weight: bold; + font-size: 100%; +} + +.constant { + font-family: monospace; + font-size: 100%; + color: #da70d6; +} + +a { + color: blue; + text-decoration:none; +} + +a:hover { + text-decoration:underline; +} + +.itemizedlist { + list-style-type: disk; +} + +.inline-list li { + display: inline; + list-style-type: disk; +} + +.vert-list { + list-style-type: disk; +} + +pre { + margin-bottom: 0px; + margin-top: 0px; +} + +.leftpart { + position:absolute; + float:left; + width: 186px; + padding: 5px; + font-size: smaller; +} + +.content { + margin-top: 100px; + margin-left: 196px +} + +.container { + margin: 0 auto; + width:1024px; +} + +ul.toc li.list-active { + list-style-type:disc; + font-weight:bold; +} + +ul.toc li.parent { + font-size: 115%; + padding: 5px 0px 5px 11px; + border-bottom: 1px solid #cccccc; + margin-bottom: 5px; +} + +ul.toc li.root { + font-size: 135%; + padding: 5px 0px 5px 11px; + border-bottom: 1px solid #cccccc; + margin-bottom: 5px; +} + +ul.toc li { + font-size: 85%; + margin: 1px 0 1px 1px; + padding: 1px 0 1px 11px; + background-repeat: no-repeat; + background-position: center left; + list-style-type: circle; +} + +.next { + float:right; + text-align: right; +} + +.center { + text-align: center; +} + +.screen { + font-family: monospace; + font-size: 100%; + background-color:#FFFFFF; + border-color:#CCCCCC; + border-style:solid; + border-width:2px medium; + width:80%; + color:#333333; + line-height:120%; + padding:10px; +} + +/* Top and bottom navigation controls on manual pages --------------------- */ +div.manualnavbar { + background-color: #E0E0E0; + color: inherit; + padding: 4px; + margin-bottom: 10px; +} +div.manualnavbar .prev { + padding-right: 4px; +} +div.manualnavbar .next { + text-align: right; + padding-left: 4px; +} + +div.manualnavbar .top { + text-align: center; + display: block; +} + +div.manualnavbar hr { + color: #cccccc; + background-color: #cccccc; +} + +/* Footer navigation area ------------------------------------------------- */ + +#pagefooter { + position: relative; + font-size: 75%; + color: inherit; + background-color: #e5e5e5; + width: 100%; +} + +#pagefooterleft { + top: 0px; + left: 0px; + padding: 6px; + margin-right: 30%; +} + +#pagefooterright { + text-align: right; + margin-left: 50%; + padding: 6px; +} +#footnav { + color: inherit; + background-color: #9999cc; + border-width: 1px 0px; + border-color: #333366; + border-style: solid; + text-align: right; + padding-right: 6px; +} + + + + + #global{ +/* width: 90%; */ + max-width: 90em; +/* min-width: 850px; */ + margin-left: auto; + margin-right: auto; + } + + #myHeader{ + background-color:#000000; + color:white; + margin-bottom : 10px; + position : relative; + text-align: center; +/* width : 1024px;*/ + height : 100px; + padding-left : 20px; + background : url("http://atoms.scilab.org/images/homepage/cadre_head.png"); + background-repeat : no-repeat; + background-position : 0px 0px; + + } + + #myFooter{ + background-color:#E5E5E5; + font-color:black; +/* width: 90%;*/ + max-width: 90em; +/* min-width: 850px; + margin-left: 5%; + margin-right: 5%;*/ + margin-top:10px; + padding:10px; + } + + #mainArea{ + width: 100%; + overflow: hidden; + } + + #myLeftArea{ + color:white; + float: left; + width: 180px; + padding:5px; + } + + #myMiddleArea{ + color:black; + margin-left: 200px; + padding: 10px 20px; + } + + #myRightArea{ + color:white; + float: right; + width: 200px; + padding: 12px 20px; + } + + +div#cadre_head +{ + position : relative; + text-align: center; +/* width : 1024px;*/ + height : 100px; + padding-left : 20px; + background : url("/img/cadre_head.png"); + background-repeat : no-repeat; + background-position : 0px 0px; +} + + +div#slogan{ + position: absolute; + top : 50px; + left:251px; + color:#0000AA; + font: 120%, Georgia,Serif; +} +div#cadre_help +{ + position: absolute; + top:45px; + right:0px; + font-size:0.8em; + color:#0000AA; +} + +table.revhistory +{ + width:80%; + border-color:#CCCCCC; + border-style:solid; + border-width:2px medium; + margin-bottom: 10px; +} + +table.revhistory tr.title td +{ + background-color: #9999CC; +}
\ No newline at end of file diff --git a/help/en_US/scilab_en_US_help/sym_addConstr.html b/help/en_US/scilab_en_US_help/sym_addConstr.html new file mode 100644 index 0000000..75f86e3 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_addConstr.html @@ -0,0 +1,91 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_addConstr</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html"><< Symphony Toolbox</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_addVar.html">sym_addVar >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_addConstr</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_addConstr</h1> + <p class="refpurpose">Add a new constraint</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_addConstr</span><span class="default">(</span><span class="default">coeff</span><span class="default">,</span><span class="default">type</span><span class="default">,</span><span class="default">bound1</span><span class="default">[,</span><span class="default">bound2</span><span class="default">])</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">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.</p> + <p class="para">The last argument is only required for ranged constraints. For the other types of constraints, only the third argument is required.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">coeff</span> + <dd><p class="para">Sparse matrix representing coefficients of the variables in the new constraint (must have 1 row and number of columns equal to number of variables)</p></dd></dt> + <dt><span class="term">type</span> + <dd><p class="para">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")</p></dd></dt> + <dt><span class="term">bound1</span> + <dd><p class="para">The first (or only) bound for the constraint</p></dd></dt> + <dt><span class="term">bound2</span> + <dd><p class="para">The second bound for ranged constraints. The two bounds for ranged constraints can be in any order.</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_addConstr</span><span class="scilabopenclose">(</span><a class="scilabcommand" href="scilab://sparse">sparse</a><span class="scilabopenclose">(</span><span class="scilabopenclose">[</span><span class="scilabnumber">0</span><span class="scilabdefault">,</span><span class="scilabnumber">0</span><span class="scilabdefault">,</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span><span class="scilabnumber">0</span><span class="scilabdefault">,</span><span class="scilabnumber">2</span><span class="scilabopenclose">]</span><span class="scilabopenclose">)</span><span class="scilabdefault">,</span><span class="scilabstring">"</span><span class="scilabstring">R</span><span class="scilabstring">"</span><span class="scilabdefault">,</span><span class="scilabnumber">0</span><span class="scilabdefault">,</span><span class="scilabnumber">10</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div> + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_addConstr</span><span class="scilabopenclose">(</span><a class="scilabcommand" href="scilab://sparse">sparse</a><span class="scilabopenclose">(</span><span class="scilabopenclose">[</span><span class="scilabnumber">0</span><span class="scilabdefault">,</span><span class="scilabnumber">0</span><span class="scilabdefault">,</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span><span class="scilabnumber">0</span><span class="scilabopenclose">]</span><span class="scilabopenclose">)</span><span class="scilabdefault">,</span><span class="scilabstring">"</span><span class="scilabstring">G</span><span class="scilabstring">"</span><span class="scilabdefault">,</span><span class="scilabnumber">4</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html"><< Symphony Toolbox</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_addVar.html">sym_addVar >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_addVar.html b/help/en_US/scilab_en_US_help/sym_addVar.html new file mode 100644 index 0000000..888cfc8 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_addVar.html @@ -0,0 +1,93 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_addVar</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_addConstr.html"><< sym_addConstr</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_close.html">sym_close >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_addVar</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_addVar</h1> + <p class="refpurpose">Add a new variable</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_addVar</span><span class="default">(</span><span class="default">coeff</span><span class="default">,</span><span class="default">lower</span><span class="default">,</span><span class="default">upper</span><span class="default">,</span><span class="default">obj</span><span class="default">,</span><span class="default">isInt</span><span class="default">,</span><span class="default">name</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This function adds a new variable from scratch.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">coeff</span> + <dd><p class="para">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)</p></dd></dt> + <dt><span class="term">lower</span> + <dd><p class="para">Lower bound of the new variable</p></dd></dt> + <dt><span class="term">upper</span> + <dd><p class="para">Upper bound of the new variable</p></dd></dt> + <dt><span class="term">obj</span> + <dd><p class="para">Coefficient of the variable in the objective function</p></dd></dt> + <dt><span class="term">isInt</span> + <dd><p class="para">Wether the variable is constrainted to be an integer (boolean %t or %f)</p></dd></dt> + <dt><span class="term">name</span> + <dd><p class="para">Name of the new variable</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_addVar</span><span class="scilabopenclose">(</span><a class="scilabcommand" href="scilab://sparse">sparse</a><span class="scilabopenclose">(</span><span class="scilabopenclose">[</span><span class="scilabnumber">0</span><span class="scilabdefault">;</span><span class="scilabnumber">0</span><span class="scilabdefault">;</span><span class="scilabnumber">1</span><span class="scilabdefault">;</span><span class="scilabnumber">2</span><span class="scilabdefault">;</span><span class="scilabnumber">0</span><span class="scilabdefault">;</span><span class="scilabnumber">0</span><span class="scilabopenclose">]</span><span class="scilabopenclose">)</span><span class="scilabdefault">,</span><span class="scilabnumber">0</span><span class="scilabdefault">,</span><span class="scilabconstants">%inf</span><span class="scilabdefault">,</span><span class="scilabnumber">1.2</span><span class="scilabdefault">,</span><span class="scilabconstants">%t</span><span class="scilabdefault">,</span><span class="scilabstring">"</span><span class="scilabstring">part1</span><span class="scilabstring">"</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_addConstr.html"><< sym_addConstr</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_close.html">sym_close >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_close.html b/help/en_US/scilab_en_US_help/sym_close.html new file mode 100644 index 0000000..b19a7a9 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_close.html @@ -0,0 +1,84 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_close</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_addVar.html"><< sym_addVar</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_deleteConstrs.html">sym_deleteConstrs >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_close</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_close</h1> + <p class="refpurpose">Close the Symphony environment</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_close</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">Closes the already open Symphony environment.</p> + <p class="para">Warning: All data loaded into the environment is deleted.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 1 if the environment was successfully closed and 0 otherwise</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_close</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li> + <li class="member">Iswarya</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_addVar.html"><< sym_addVar</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_deleteConstrs.html">sym_deleteConstrs >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_deleteConstrs.html b/help/en_US/scilab_en_US_help/sym_deleteConstrs.html new file mode 100644 index 0000000..1363cb8 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_deleteConstrs.html @@ -0,0 +1,81 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_deleteConstrs</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_close.html"><< sym_close</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_deleteVars.html">sym_deleteVars >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_deleteConstrs</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_deleteConstrs</h1> + <p class="refpurpose">This routine is used to delete rows from the original constraint matrix.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_deleteConstrs</span><span class="default">(</span><span class="default">indices</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">indices</span> + <dd><p class="para">An array indicating the indices of the rows to be deleted.</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0 if the constraints specified in the indices are deleted successfully and 0 if it returns corresponding to an error value.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_deleteConstrs</span><span class="scilabopenclose">(</span><span class="scilabopenclose">[</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span><span class="scilabnumber">2</span><span class="scilabopenclose">]</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Iswarya Hariharan</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_close.html"><< sym_close</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_deleteVars.html">sym_deleteVars >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_deleteVars.html b/help/en_US/scilab_en_US_help/sym_deleteVars.html new file mode 100644 index 0000000..912d866 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_deleteVars.html @@ -0,0 +1,81 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_deleteVars</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_deleteConstrs.html"><< sym_deleteConstrs</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getConstrActivity.html">sym_getConstrActivity >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_deleteVars</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_deleteVars</h1> + <p class="refpurpose">This routine is used to delete columns from the original problem description.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_deleteVars</span><span class="default">(</span><span class="default">indices</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">indices</span> + <dd><p class="para">Pointer to an integer type array indicating the indices of the column numbers(variables) to be deleted.</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_deleteVars</span><span class="scilabopenclose">(</span><span class="scilabopenclose">[</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span><span class="scilabnumber">2</span><span class="scilabopenclose">]</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Iswarya Hariharan</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_deleteConstrs.html"><< sym_deleteConstrs</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getConstrActivity.html">sym_getConstrActivity >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getConstrActivity.html b/help/en_US/scilab_en_US_help/sym_getConstrActivity.html new file mode 100644 index 0000000..2e4499f --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getConstrActivity.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getConstrActivity</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_deleteVars.html"><< sym_deleteVars</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getConstrLower.html">sym_getConstrLower >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getConstrActivity</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getConstrActivity</h1> + <p class="refpurpose">Get the activity of the constraints in the solution</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getConstrActivity</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">Get the activity of the constraints in the solution.</p> + <p class="para">This function may fail if the problem has not been solved already. Use sym_solve() in this case.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns a matrix with 1 column and number of rows equal to number of constraints, that represents the activities of those constraints</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_getConstrActivity</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_deleteVars.html"><< sym_deleteVars</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getConstrLower.html">sym_getConstrLower >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getConstrLower.html b/help/en_US/scilab_en_US_help/sym_getConstrLower.html new file mode 100644 index 0000000..df6fe6d --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getConstrLower.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getConstrLower</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getConstrActivity.html"><< sym_getConstrActivity</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getConstrRange.html">sym_getConstrRange >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getConstrLower</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getConstrLower</h1> + <p class="refpurpose">To get the lower bounds of the constraints.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getConstrLower</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine is used to get lower bounds of constraints.</p> + <p class="para">If there was an error it prints to Scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">It returns a column vector of lower bounds of constraints.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">ans</span><span class="scilaboperator">=</span><span class="scilabid">sym_getConstrLower</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getConstrActivity.html"><< sym_getConstrActivity</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getConstrRange.html">sym_getConstrRange >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getConstrRange.html b/help/en_US/scilab_en_US_help/sym_getConstrRange.html new file mode 100644 index 0000000..40aadea --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getConstrRange.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getConstrRange</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getConstrLower.html"><< sym_getConstrLower</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getConstrSense.html">sym_getConstrSense >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getConstrRange</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getConstrRange</h1> + <p class="refpurpose">To to get the constraint ranges.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getConstrRange</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine is used to get the constraint ranges.</p> + <p class="para">If there was an error it prints to Scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">It returns a column vector of the constraint ranges.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">ans</span><span class="scilaboperator">=</span><span class="scilabid">sym_getConstrRange</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getConstrLower.html"><< sym_getConstrLower</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getConstrSense.html">sym_getConstrSense >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getConstrSense.html b/help/en_US/scilab_en_US_help/sym_getConstrSense.html new file mode 100644 index 0000000..d41a31b --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getConstrSense.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getConstrSense</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getConstrRange.html"><< sym_getConstrRange</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getConstrUpper.html">sym_getConstrUpper >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getConstrSense</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getConstrSense</h1> + <p class="refpurpose">To get the row senses.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getConstrSense</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine is used to get the row senses.</p> + <p class="para">If there was an error it prints to Scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">It returns a column vector of the row senses.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">ans</span><span class="scilaboperator">=</span><span class="scilabid">sym_getConstrSense</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getConstrRange.html"><< sym_getConstrRange</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getConstrUpper.html">sym_getConstrUpper >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getConstrUpper.html b/help/en_US/scilab_en_US_help/sym_getConstrUpper.html new file mode 100644 index 0000000..c308815 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getConstrUpper.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getConstrUpper</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getConstrSense.html"><< sym_getConstrSense</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getDblParam.html">sym_getDblParam >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getConstrUpper</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getConstrUpper</h1> + <p class="refpurpose">To get the upper bounds of the constraints.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getConstrUpper</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine is used to get upper bounds of the constraints.</p> + <p class="para">If there was an error it prints to Scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">It returns a column vector of upper bounds of constraints.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">ans</span><span class="scilaboperator">=</span><span class="scilabid">sym_getConstrUpper</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getConstrSense.html"><< sym_getConstrSense</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getDblParam.html">sym_getDblParam >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getDblParam.html b/help/en_US/scilab_en_US_help/sym_getDblParam.html new file mode 100644 index 0000000..8f3d740 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getDblParam.html @@ -0,0 +1,81 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getDblParam</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getConstrUpper.html"><< sym_getConstrUpper</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getInfinity.html">sym_getInfinity >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getDblParam</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getDblParam</h1> + <p class="refpurpose">This routine is used to get the value of a double type parameter.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getDblParam</span><span class="default">(</span><span class="default">key</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">key</span> + <dd><p class="para">The name of the double parameter whose value has to be retrieved. Note: should be given within " "</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_getDblParam</span><span class="scilabopenclose">(</span><span class="scilabstring">"</span><span class="scilabstring">time_limit</span><span class="scilabstring">"</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Iswarya Hariharan</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getConstrUpper.html"><< sym_getConstrUpper</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getInfinity.html">sym_getInfinity >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getInfinity.html b/help/en_US/scilab_en_US_help/sym_getInfinity.html new file mode 100644 index 0000000..4c9b053 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getInfinity.html @@ -0,0 +1,82 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getInfinity</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getDblParam.html"><< sym_getDblParam</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getIntParam.html">sym_getIntParam >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getInfinity</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getInfinity</h1> + <p class="refpurpose">Get Symphony's infinity value</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getInfinity</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">Get the value that Symphony considers to be infinity. This is equal to 10^20.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns the infinity value of Symphony</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_getInfinity</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getDblParam.html"><< sym_getDblParam</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getIntParam.html">sym_getIntParam >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getIntParam.html b/help/en_US/scilab_en_US_help/sym_getIntParam.html new file mode 100644 index 0000000..1bc9086 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getIntParam.html @@ -0,0 +1,81 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getIntParam</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getInfinity.html"><< sym_getInfinity</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getIterCount.html">sym_getIterCount >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getIntParam</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getIntParam</h1> + <p class="refpurpose">This routine is used to get the value of an integer type parameter.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getIntParam</span><span class="default">(</span><span class="default">key</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">key</span> + <dd><p class="para">The name of the integer parameter whose value has to be retrieved. Note: should be given within " "</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_getIntParam</span><span class="scilabopenclose">(</span><span class="scilabstring">"</span><span class="scilabstring">verbosity</span><span class="scilabstring">"</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Iswarya Hariharan</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getInfinity.html"><< sym_getInfinity</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getIterCount.html">sym_getIterCount >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getIterCount.html b/help/en_US/scilab_en_US_help/sym_getIterCount.html new file mode 100644 index 0000000..81aaba5 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getIterCount.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getIterCount</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getIntParam.html"><< sym_getIntParam</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getMatrix.html">sym_getMatrix >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getIterCount</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getIterCount</h1> + <p class="refpurpose">To get the number of the analyzed nodes of the branching tree after solving the problem.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getIterCount</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine is used to get the number of the analyzed nodes of the branching tree after solving the problem.</p> + <p class="para">If there was an error it prints to Scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">It returns iteration count.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">ans</span><span class="scilaboperator">=</span><span class="scilabid">sym_getIterCount</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getIntParam.html"><< sym_getIntParam</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getMatrix.html">sym_getMatrix >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getMatrix.html b/help/en_US/scilab_en_US_help/sym_getMatrix.html new file mode 100644 index 0000000..416a75c --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getMatrix.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getMatrix</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getIterCount.html"><< sym_getIterCount</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getNumConstr.html">sym_getNumConstr >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getMatrix</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getMatrix</h1> + <p class="refpurpose">To get the constraint matrix.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getMatrix</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine is used to get the constraint matrix as sparse matrix in a standard row-ordered format.</p> + <p class="para">If there was an error it prints to Scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">It returns a row-ordered sparse matrix.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">ans</span><span class="scilaboperator">=</span><span class="scilabid">sym_getMatrix</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getIterCount.html"><< sym_getIterCount</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getNumConstr.html">sym_getNumConstr >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getNumConstr.html b/help/en_US/scilab_en_US_help/sym_getNumConstr.html new file mode 100644 index 0000000..8aa207a --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getNumConstr.html @@ -0,0 +1,82 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getNumConstr</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getMatrix.html"><< sym_getMatrix</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getNumElements.html">sym_getNumElements >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getNumConstr</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getNumConstr</h1> + <p class="refpurpose">To get the number of the constraints of the current problem.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getNumConstr</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine is used to get the number of the constraints of the current problem.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">ans</span><span class="scilaboperator">=</span><span class="scilabid">sym_getNumConstr</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getMatrix.html"><< sym_getMatrix</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getNumElements.html">sym_getNumElements >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getNumElements.html b/help/en_US/scilab_en_US_help/sym_getNumElements.html new file mode 100644 index 0000000..21782aa --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getNumElements.html @@ -0,0 +1,82 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getNumElements</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getNumConstr.html"><< sym_getNumConstr</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getNumVar.html">sym_getNumVar >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getNumElements</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getNumElements</h1> + <p class="refpurpose">To get the number of non-zero entries of the constraint matrix of the current problem.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getNumElements</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine is used to get the number of non-zero entries of the constraint matrix of the current problem.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">ans</span><span class="scilaboperator">=</span><span class="scilabid">sym_getNumElements</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getNumConstr.html"><< sym_getNumConstr</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getNumVar.html">sym_getNumVar >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getNumVar.html b/help/en_US/scilab_en_US_help/sym_getNumVar.html new file mode 100644 index 0000000..755b9cb --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getNumVar.html @@ -0,0 +1,82 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getNumVar</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getNumElements.html"><< sym_getNumElements</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getObjCoeff.html">sym_getObjCoeff >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getNumVar</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getNumVar</h1> + <p class="refpurpose">To get the number of the variables of the current problem.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getNumVar</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine is used to get the number of the variables of the current problem.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">ans</span><span class="scilaboperator">=</span><span class="scilabid">sym_getNumVar</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getNumElements.html"><< sym_getNumElements</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getObjCoeff.html">sym_getObjCoeff >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getObjCoeff.html b/help/en_US/scilab_en_US_help/sym_getObjCoeff.html new file mode 100644 index 0000000..010f87a --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getObjCoeff.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getObjCoeff</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getNumVar.html"><< sym_getNumVar</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getObjSense.html">sym_getObjSense >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getObjCoeff</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getObjCoeff</h1> + <p class="refpurpose">To get the objective vector.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getObjCoeff</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine is used to get the objective vector.</p> + <p class="para">If there was an error it prints to Scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">It returns a row vector of coefficients of variables in objective.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">ans</span><span class="scilaboperator">=</span><span class="scilabid">sym_getObjCoeff</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getNumVar.html"><< sym_getNumVar</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getObjSense.html">sym_getObjSense >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getObjSense.html b/help/en_US/scilab_en_US_help/sym_getObjSense.html new file mode 100644 index 0000000..61bbe20 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getObjSense.html @@ -0,0 +1,82 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getObjSense</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getObjCoeff.html"><< sym_getObjCoeff</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getObjVal.html">sym_getObjVal >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getObjSense</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getObjSense</h1> + <p class="refpurpose">Get the objective sense</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getObjSense</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This function gets the sense of the objective function (minimization/maximization).</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 1 if the objective is to be minimized and -1 if the objective is to be maximized</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_getObjSense</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getObjCoeff.html"><< sym_getObjCoeff</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getObjVal.html">sym_getObjVal >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getObjVal.html b/help/en_US/scilab_en_US_help/sym_getObjVal.html new file mode 100644 index 0000000..17d125a --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getObjVal.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getObjVal</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getObjSense.html"><< sym_getObjSense</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getPrimalBound.html">sym_getPrimalBound >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getObjVal</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getObjVal</h1> + <p class="refpurpose">Get the optimized objective value</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getObjVal</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">Get the optimized objective value after after solving the problem.</p> + <p class="para">This function may fail if the problem has not been solved already. Use sym_solve() in this case.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns the optimized objective value</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_getObjVal</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getObjSense.html"><< sym_getObjSense</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getPrimalBound.html">sym_getPrimalBound >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getPrimalBound.html b/help/en_US/scilab_en_US_help/sym_getPrimalBound.html new file mode 100644 index 0000000..63f43f4 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getPrimalBound.html @@ -0,0 +1,82 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getPrimalBound</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getObjVal.html"><< sym_getObjVal</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getRhs.html">sym_getRhs >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getPrimalBound</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getPrimalBound</h1> + <p class="refpurpose">Get the primal bound of the problem</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getPrimalBound</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">Get the primal bound of the loaded problem.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns the primal bound of the problem</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_getPrimalBound</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getObjVal.html"><< sym_getObjVal</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getRhs.html">sym_getRhs >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getRhs.html b/help/en_US/scilab_en_US_help/sym_getRhs.html new file mode 100644 index 0000000..28c94b7 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getRhs.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getRhs</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getPrimalBound.html"><< sym_getPrimalBound</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getStatus.html">sym_getStatus >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getRhs</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getRhs</h1> + <p class="refpurpose">To to get the right hand side vector(column vector).</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getRhs</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine is used to get the right hand side vector(coumn vector).</p> + <p class="para">If there was an error it prints to Scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">It returns a column vector of the right hand side values of constraints.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">ans</span><span class="scilaboperator">=</span><span class="scilabid">sym_getRhs</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getPrimalBound.html"><< sym_getPrimalBound</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getStatus.html">sym_getStatus >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getStatus.html b/help/en_US/scilab_en_US_help/sym_getStatus.html new file mode 100644 index 0000000..d7d48e3 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getStatus.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getStatus</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getRhs.html"><< sym_getRhs</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getStrParam.html">sym_getStrParam >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getStatus</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getStatus</h1> + <p class="refpurpose">To get status of the problem solver.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getStatus</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This post-solution query routine is used to learn the termination status of the solution procedure.</p> + <p class="para">It prints status of the problem solver to scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_getStatus</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getRhs.html"><< sym_getRhs</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getStrParam.html">sym_getStrParam >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getStrParam.html b/help/en_US/scilab_en_US_help/sym_getStrParam.html new file mode 100644 index 0000000..f525a9f --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getStrParam.html @@ -0,0 +1,81 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getStrParam</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getStatus.html"><< sym_getStatus</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getVarLower.html">sym_getVarLower >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getStrParam</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getStrParam</h1> + <p class="refpurpose">This routine is used to get the value of a string type parameter.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getStrParam</span><span class="default">(</span><span class="default">key</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">key</span> + <dd><p class="para">The name of the strung parameter whose value has to be retrieved. Note: should be given within " "</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_getStrParam</span><span class="scilabopenclose">(</span><span class="scilabstring">"</span><span class="scilabstring">source_path</span><span class="scilabstring">"</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Iswarya Hariharan</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getStatus.html"><< sym_getStatus</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getVarLower.html">sym_getVarLower >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getVarLower.html b/help/en_US/scilab_en_US_help/sym_getVarLower.html new file mode 100644 index 0000000..24c164c --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getVarLower.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getVarLower</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getStrParam.html"><< sym_getStrParam</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getVarSoln.html">sym_getVarSoln >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getVarLower</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getVarLower</h1> + <p class="refpurpose">To get the lower bounds of the variables.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getVarLower</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine is used to get the lower bounds of the variables.</p> + <p class="para">If there was an error it prints to Scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">It returns a row vector of lower bounds of the variables.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">ans</span><span class="scilaboperator">=</span><span class="scilabid">sym_getVarLower</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getStrParam.html"><< sym_getStrParam</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getVarSoln.html">sym_getVarSoln >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getVarSoln.html b/help/en_US/scilab_en_US_help/sym_getVarSoln.html new file mode 100644 index 0000000..4d3614a --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getVarSoln.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getVarSoln</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getVarLower.html"><< sym_getVarLower</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getVarUpper.html">sym_getVarUpper >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getVarSoln</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getVarSoln</h1> + <p class="refpurpose">Get the solution for the problem</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getVarSoln</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">Get the solution for the problem after solving it.</p> + <p class="para">This function may fail if the problem has not been solved already. Use sym_solve() in this case.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns a matrix with 1 row and number of columns equal to number of variables, that represents the solutions for those variables</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_getVarSoln</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getVarLower.html"><< sym_getVarLower</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_getVarUpper.html">sym_getVarUpper >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_getVarUpper.html b/help/en_US/scilab_en_US_help/sym_getVarUpper.html new file mode 100644 index 0000000..44e0692 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_getVarUpper.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_getVarUpper</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getVarSoln.html"><< sym_getVarSoln</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isAbandoned.html">sym_isAbandoned >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_getVarUpper</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_getVarUpper</h1> + <p class="refpurpose">To get the upper bounds of the variables.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_getVarUpper</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine is used to get the upper bounds of the variables.</p> + <p class="para">If there was an error it prints to Scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">It returns a row vector of upper bounds of the variables.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">ans</span><span class="scilaboperator">=</span><span class="scilabid">sym_getVarUpper</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getVarSoln.html"><< sym_getVarSoln</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isAbandoned.html">sym_isAbandoned >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_isAbandoned.html b/help/en_US/scilab_en_US_help/sym_isAbandoned.html new file mode 100644 index 0000000..c8a4b5b --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_isAbandoned.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_isAbandoned</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_getVarUpper.html"><< sym_getVarUpper</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isBinary.html">sym_isBinary >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_isAbandoned</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_isAbandoned</h1> + <p class="refpurpose">To check whether the problem was abandoned for some reason.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_isAbandoned</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This post-solution query routine is used to learn whether the problem was abandoned for some reason.</p> + <p class="para">It prints whether or not the problem was abandoned for some reason to scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">It returns 1 if the problem was abandoned or 0 if the problem was not abandoned or -1 if there was an error.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_isAbandoned</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_getVarUpper.html"><< sym_getVarUpper</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isBinary.html">sym_isBinary >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_isBinary.html b/help/en_US/scilab_en_US_help/sym_isBinary.html new file mode 100644 index 0000000..6b776bf --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_isBinary.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_isBinary</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_isAbandoned.html"><< sym_isAbandoned</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isContinuous.html">sym_isContinuous >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_isBinary</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_isBinary</h1> + <p class="refpurpose">Check if a variable is constrained to be binary</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_isBinary</span><span class="default">(</span><span class="default">index</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This function checks if a variable is constrained to be binary (0 or 1).</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">index</span> + <dd><p class="para">Index of the variable to check. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 1 if the variable is constrained to be binary and 0 if it is not.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_isBinary</span><span class="scilabopenclose">(</span><span class="scilabnumber">2</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_isAbandoned.html"><< sym_isAbandoned</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isContinuous.html">sym_isContinuous >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_isContinuous.html b/help/en_US/scilab_en_US_help/sym_isContinuous.html new file mode 100644 index 0000000..f13df60 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_isContinuous.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_isContinuous</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_isBinary.html"><< sym_isBinary</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isEnvActive.html">sym_isEnvActive >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_isContinuous</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_isContinuous</h1> + <p class="refpurpose">Check if a variable is continuous</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_isContinuous</span><span class="default">(</span><span class="default">index</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This function checks if a variable is continuous.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">index</span> + <dd><p class="para">Index of the variable to check. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 1 if the variable is continuous and 0 if it is not.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_isContinuous</span><span class="scilabopenclose">(</span><span class="scilabnumber">2</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_isBinary.html"><< sym_isBinary</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isEnvActive.html">sym_isEnvActive >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_isEnvActive.html b/help/en_US/scilab_en_US_help/sym_isEnvActive.html new file mode 100644 index 0000000..bb9c92e --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_isEnvActive.html @@ -0,0 +1,82 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_isEnvActive</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_isContinuous.html"><< sym_isContinuous</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isInfeasible.html">sym_isInfeasible >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_isEnvActive</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_isEnvActive</h1> + <p class="refpurpose">Check if Symphony environment is active</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_isEnvActive</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">Check if Symphony environment is active (open). Most Symphony functions will require the environment to be open.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 1 if the environment is active and 0 otherwise</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_isEnvActive</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_isContinuous.html"><< sym_isContinuous</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isInfeasible.html">sym_isInfeasible >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_isInfeasible.html b/help/en_US/scilab_en_US_help/sym_isInfeasible.html new file mode 100644 index 0000000..aaccbe5 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_isInfeasible.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_isInfeasible</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_isEnvActive.html"><< sym_isEnvActive</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isInteger.html">sym_isInteger >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_isInfeasible</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_isInfeasible</h1> + <p class="refpurpose">To check whether the problem was proven to be infeasible.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_isInfeasible</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This post-solution query routine is used to learn whether the problem was proven to be infeasible.</p> + <p class="para">It prints whether or not the problem was proven to be infeasible to scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_isInfeasible</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_isEnvActive.html"><< sym_isEnvActive</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isInteger.html">sym_isInteger >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_isInteger.html b/help/en_US/scilab_en_US_help/sym_isInteger.html new file mode 100644 index 0000000..24fe712 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_isInteger.html @@ -0,0 +1,77 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_isInteger</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_isInfeasible.html"><< sym_isInfeasible</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isIterLimitReached.html">sym_isIterLimitReached >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_isInteger</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_isInteger</h1> + + <p class="refpurpose">Check if a variable is constrained to be an integer</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + + <div class="synopsis"><pre><span class="functionid">sym_isInteger</span><span class="default">(</span><span class="default">index</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This function checks if a variable is constrained to be an integer.</p> + <p class="para">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</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_isInteger</span><span class="scilabopenclose">(</span><span class="scilabnumber">2</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_isInfeasible.html"><< sym_isInfeasible</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isIterLimitReached.html">sym_isIterLimitReached >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_isIterLimitReached.html b/help/en_US/scilab_en_US_help/sym_isIterLimitReached.html new file mode 100644 index 0000000..cebfaa2 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_isIterLimitReached.html @@ -0,0 +1,84 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_isIterLimitReached</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_isInteger.html"><< sym_isInteger</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isOptimal.html">sym_isOptimal >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_isIterLimitReached</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_isIterLimitReached</h1> + <p class="refpurpose">To know whether the iteration limit (node limit) was reached.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_isIterLimitReached</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This post-solution query routine is used to learn whether the iteration limit(node limit) was reached.</p> + <p class="para">It prints whether or not the iteration limit (node limit) was reached to scilab console.</p> + <p class="para">It can also be used if "find first feasible" parameter was set to true before solving the problem.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_isIterLimitReached</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_isInteger.html"><< sym_isInteger</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isOptimal.html">sym_isOptimal >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_isOptimal.html b/help/en_US/scilab_en_US_help/sym_isOptimal.html new file mode 100644 index 0000000..5dcd63e --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_isOptimal.html @@ -0,0 +1,84 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_isOptimal</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_isIterLimitReached.html"><< sym_isIterLimitReached</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isTargetGapAchieved.html">sym_isTargetGapAchieved >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_isOptimal</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_isOptimal</h1> + <p class="refpurpose">To check whether the problem was solved to optimality.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_isOptimal</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This post-solution query routine is used to learn whether the problem was solved to</p> + <p class="para">optimality.</p> + <p class="para">It prints whether or not the problem was solved to optimality to scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_isOptimal</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_isIterLimitReached.html"><< sym_isIterLimitReached</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isTargetGapAchieved.html">sym_isTargetGapAchieved >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_isTargetGapAchieved.html b/help/en_US/scilab_en_US_help/sym_isTargetGapAchieved.html new file mode 100644 index 0000000..4567289 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_isTargetGapAchieved.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_isTargetGapAchieved</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_isOptimal.html"><< sym_isOptimal</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isTimeLimitReached.html">sym_isTimeLimitReached >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_isTargetGapAchieved</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_isTargetGapAchieved</h1> + <p class="refpurpose">To know whether the target gap was reached.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_isTargetGapAchieved</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This post-solution query routine is used to learn whether the target gap was reached.</p> + <p class="para">It print whether or not the target gap was reached.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_isTargetGapAchieved</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_isOptimal.html"><< sym_isOptimal</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_isTimeLimitReached.html">sym_isTimeLimitReached >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_isTimeLimitReached.html b/help/en_US/scilab_en_US_help/sym_isTimeLimitReached.html new file mode 100644 index 0000000..c915409 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_isTimeLimitReached.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_isTimeLimitReached</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_isTargetGapAchieved.html"><< sym_isTargetGapAchieved</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_loadMPS.html">sym_loadMPS >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_isTimeLimitReached</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_isTimeLimitReached</h1> + <p class="refpurpose">To know whether the time limit was reached.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_isTimeLimitReached</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This post-solution query routine is used to learn whether the time limit was reached.</p> + <p class="para">It prints whether or not the time limit was reached to scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_isTimeLimitReached</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_isTargetGapAchieved.html"><< sym_isTargetGapAchieved</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_loadMPS.html">sym_loadMPS >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_loadMPS.html b/help/en_US/scilab_en_US_help/sym_loadMPS.html new file mode 100644 index 0000000..f3912cf --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_loadMPS.html @@ -0,0 +1,82 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_loadMPS</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_isTimeLimitReached.html"><< sym_isTimeLimitReached</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_loadProblem.html">sym_loadProblem >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_loadMPS</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_loadMPS</h1> + <p class="refpurpose">This routine is used to load an instance from an MPS file.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_loadMPS</span><span class="default">(</span><span class="default">filename</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">filename</span> + <dd><p class="para">It is a string that has the path of the .mps file to loaded.It has to be given within double quotes ("")</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_loadMPS</span><span class="scilabopenclose">(</span><span class="scilabstring">"</span><span class="scilabstring">./sample.mps</span><span class="scilabstring">"</span><span class="scilabopenclose">)</span> <span class="scilaboperator">-</span><span class="scilabid">mps</span> <a class="scilabcommand" href="scilab://file">file</a> <span class="scilabstring">present</span> <span class="scilabstring">in</span> <span class="scilabstring">the</span> <span class="scilabstring">current</span> <span class="scilabstring">directory</span> <span class="scilabstring">of</span> <span class="scilabstring">execution</span> <span class="scilabstring">can</span> <span class="scilabstring">be</span> <span class="scilabstring">mentioned</span> <span class="scilabstring">this</span> <span class="scilabstring">way</span> <span class="scilabstring">also</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div> + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_loadMPS</span><span class="scilabopenclose">(</span><span class="scilabstring">"</span><span class="scilabstring">/home/Desktop/sample.mps</span><span class="scilabstring">"</span><span class="scilabopenclose">)</span> <span class="scilaboperator">-</span><span class="scilabid">mps</span> <a class="scilabcommand" href="scilab://file">file</a> <span class="scilabstring">present</span> <span class="scilabstring">at</span> <span class="scilabstring">a</span> <span class="scilabstring">different</span> <span class="scilabstring">location</span> <span class="scilabstring">must</span> <span class="scilabstring">be</span> <span class="scilabstring">specified</span> <span class="scilabstring">with</span> <span class="scilabstring">their</span> <span class="scilabstring">entire</span> <span class="scilabstring">path</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Iswarya Hariharan</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_isTimeLimitReached.html"><< sym_isTimeLimitReached</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_loadProblem.html">sym_loadProblem >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_loadProblem.html b/help/en_US/scilab_en_US_help/sym_loadProblem.html new file mode 100644 index 0000000..e868553 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_loadProblem.html @@ -0,0 +1,102 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_loadProblem</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_loadMPS.html"><< sym_loadMPS</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_loadProblemBasic.html">sym_loadProblemBasic >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_loadProblem</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_loadProblem</h1> + <p class="refpurpose">Load a problem into Symphony</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_loadProblem</span><span class="default">(</span><span class="default">nbVar</span><span class="default">,</span><span class="default">nbConstr</span><span class="default">,</span><span class="default">varLB</span><span class="default">,</span><span class="default">varUB</span><span class="default">,</span><span class="default">objCoeff</span><span class="default">,</span><span class="default">isInt</span><span class="default">,</span><span class="default">objSense</span><span class="default">,</span><span class="default">conMatrix</span><span class="default">,</span><span class="default">conLB</span><span class="default">,</span><span class="default">conUB</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">Loads a MIP problem into Symphony. All the necessary data can be given through a single function call.</p> + <p class="para">The type of constraint is automatically deduced from the constraint bounds.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">nbVar</span> + <dd><p class="para">Number of variables</p></dd></dt> + <dt><span class="term">nbConstr</span> + <dd><p class="para">Number of constraints</p></dd></dt> + <dt><span class="term">varLB</span> + <dd><p class="para">Matrix containing lower bounds of the variables (must have size 1 row and nbVar columns). Bound can be negative infinity</p></dd></dt> + <dt><span class="term">varUB</span> + <dd><p class="para">Matrix containing upper bounds of the variables (must have size 1 row and nbVar columns). Bound can be infinity</p></dd></dt> + <dt><span class="term">objCoeff</span> + <dd><p class="para">Matrix containing coefficients of the variables in the objective (must have size 1 row and nbVar columns)</p></dd></dt> + <dt><span class="term">isInt</span> + <dd><p class="para">Boolean matrix representing wether a variable is constrained to be an integer (must have size 1 row and nbVar columns)</p></dd></dt> + <dt><span class="term">objSense</span> + <dd><p class="para">The sense (maximization/minimization) of the objective. Use sym_minimize or sym_maximize here</p></dd></dt> + <dt><span class="term">conMatrix</span> + <dd><p class="para">Sparse matrix representing the constraint matrix (must have size nbConstr rows and nbVar columns)</p></dd></dt> + <dt><span class="term">conLB</span> + <dd><p class="para">Matrix containing lower bounds of the constraints (must have size nbConstr rows and 1 column)</p></dd></dt> + <dt><span class="term">conUB</span> + <dd><p class="para">Matrix containing upper bounds of the constraints (must have size nbConstr rows and 1 column)</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0 if the problem was successfully loaded into Symphony</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_loadProblem</span><span class="scilabopenclose">(</span><span class="scilabnumber">2</span><span class="scilabdefault">,</span><span class="scilabnumber">2</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabnumber">0</span><span class="scilabdefault">,</span><span class="scilabnumber">0</span><span class="scilabopenclose">]</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabconstants">%inf</span><span class="scilabdefault">,</span><span class="scilabconstants">%inf</span><span class="scilabopenclose">]</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span><span class="scilabnumber">1</span><span class="scilabopenclose">]</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabconstants">%t</span><span class="scilabdefault">,</span><span class="scilabconstants">%t</span><span class="scilabopenclose">]</span><span class="scilabdefault">,</span><span class="scilabid">sym_maximize</span><span class="scilabdefault">,</span><a class="scilabcommand" href="scilab://sparse">sparse</a><span class="scilabopenclose">(</span><span class="scilabopenclose">[</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span><span class="scilabnumber">2</span><span class="scilabdefault">;</span><span class="scilabnumber">2</span><span class="scilabdefault">,</span><span class="scilabnumber">1</span><span class="scilabopenclose">]</span><span class="scilabopenclose">)</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabnumber">0</span><span class="scilabdefault">;</span><span class="scilabnumber">0</span><span class="scilabopenclose">]</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabnumber">7</span><span class="scilabdefault">;</span><span class="scilabnumber">6.5</span><span class="scilabopenclose">]</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_loadMPS.html"><< sym_loadMPS</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_loadProblemBasic.html">sym_loadProblemBasic >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_loadProblemBasic.html b/help/en_US/scilab_en_US_help/sym_loadProblemBasic.html new file mode 100644 index 0000000..6ec107d --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_loadProblemBasic.html @@ -0,0 +1,103 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_loadProblemBasic</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_loadProblem.html"><< sym_loadProblem</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_open.html">sym_open >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_loadProblemBasic</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_loadProblemBasic</h1> + <p class="refpurpose">Load a problem into Symphony (basic version)</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_loadProblemBasic</span><span class="default">(</span><span class="default">nbVar</span><span class="default">,</span><span class="default">nbConstr</span><span class="default">,</span><span class="default">varLB</span><span class="default">,</span><span class="default">varUB</span><span class="default">,</span><span class="default">objCoeff</span><span class="default">,</span><span class="default">isInt</span><span class="default">,</span><span class="default">objSense</span><span class="default">,</span><span class="default">conMatrix</span><span class="default">,</span><span class="default">conLB</span><span class="default">,</span><span class="default">conUB</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">Loads a MIP problem into Symphony. All the necessary data can be given through a single function call.</p> + <p class="para">The type of constraint is automatically deduced from the constraint bounds.</p> + <p class="para">This version of the problem loader does not support sparse matrices and hence is only useful for small problems.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">nbVar</span> + <dd><p class="para">Number of variables</p></dd></dt> + <dt><span class="term">nbConstr</span> + <dd><p class="para">Number of constraints</p></dd></dt> + <dt><span class="term">varLB</span> + <dd><p class="para">Matrix containing lower bounds of the variables (must have size 1 row and nbVar columns). Bound can be negative infinity</p></dd></dt> + <dt><span class="term">varUB</span> + <dd><p class="para">Matrix containing upper bounds of the variables (must have size 1 row and nbVar columns). Bound can be infinity</p></dd></dt> + <dt><span class="term">objCoeff</span> + <dd><p class="para">Matrix containing coefficients of the variables in the objective (must have size 1 row and nbVar columns)</p></dd></dt> + <dt><span class="term">isInt</span> + <dd><p class="para">Boolean matrix representing wether a variable is constrained to be an integer (must have size 1 row and nbVar columns)</p></dd></dt> + <dt><span class="term">objSense</span> + <dd><p class="para">The sense (maximization/minimization) of the objective. Use sym_minimize or sym_maximize here</p></dd></dt> + <dt><span class="term">conMatrix</span> + <dd><p class="para">Matrix (normal) representing the constraint matrix (must have size nbConstr rows and nbVar columns)</p></dd></dt> + <dt><span class="term">conLB</span> + <dd><p class="para">Matrix containing lower bounds of the constraints (must have size nbConstr rows and 1 column)</p></dd></dt> + <dt><span class="term">conUB</span> + <dd><p class="para">Matrix containing upper bounds of the constraints (must have size nbConstr rows and 1 column)</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0 if the problem was successfully loaded into Symphony</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_loadProblemBasic</span><span class="scilabopenclose">(</span><span class="scilabnumber">2</span><span class="scilabdefault">,</span><span class="scilabnumber">2</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabnumber">0</span><span class="scilabdefault">,</span><span class="scilabnumber">0</span><span class="scilabopenclose">]</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabconstants">%inf</span><span class="scilabdefault">,</span><span class="scilabconstants">%inf</span><span class="scilabopenclose">]</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span><span class="scilabnumber">1</span><span class="scilabopenclose">]</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabconstants">%t</span><span class="scilabdefault">,</span><span class="scilabconstants">%t</span><span class="scilabopenclose">]</span><span class="scilabdefault">,</span><span class="scilabid">sym_maximize</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span><span class="scilabnumber">2</span><span class="scilabdefault">;</span><span class="scilabnumber">2</span><span class="scilabdefault">,</span><span class="scilabnumber">1</span><span class="scilabopenclose">]</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabnumber">0</span><span class="scilabdefault">;</span><span class="scilabnumber">0</span><span class="scilabopenclose">]</span><span class="scilabdefault">,</span><span class="scilabopenclose">[</span><span class="scilabnumber">7</span><span class="scilabdefault">;</span><span class="scilabnumber">6.5</span><span class="scilabopenclose">]</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_loadProblem.html"><< sym_loadProblem</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_open.html">sym_open >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_open.html b/help/en_US/scilab_en_US_help/sym_open.html new file mode 100644 index 0000000..f77f98f --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_open.html @@ -0,0 +1,84 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_open</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_loadProblemBasic.html"><< sym_loadProblemBasic</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_resetParams.html">sym_resetParams >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_open</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_open</h1> + <p class="refpurpose">Open the Symphony environment</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_open</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">Opens the Symphony environment. The environment and all data loaded into it is maintained across function calls.</p> + <p class="para">This function fails if the environment is already open.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 1 if the environment was successfully opened and 0 otherwise</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_open</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li> + <li class="member">Iswarya</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_loadProblemBasic.html"><< sym_loadProblemBasic</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_resetParams.html">sym_resetParams >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_resetParams.html b/help/en_US/scilab_en_US_help/sym_resetParams.html new file mode 100644 index 0000000..1454511 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_resetParams.html @@ -0,0 +1,80 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_resetParams</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_open.html"><< sym_open</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setConstrLower.html">sym_setConstrLower >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_resetParams</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_resetParams</h1> + <p class="refpurpose">This routine sets all the environment variables and parameters to their default values.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_resetParams</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_resetParams</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Iswarya Hariharan</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_open.html"><< sym_open</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setConstrLower.html">sym_setConstrLower >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setConstrLower.html b/help/en_US/scilab_en_US_help/sym_setConstrLower.html new file mode 100644 index 0000000..9aad6b9 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setConstrLower.html @@ -0,0 +1,85 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setConstrLower</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_resetParams.html"><< sym_resetParams</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setConstrType.html">sym_setConstrType >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setConstrLower</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setConstrLower</h1> + <p class="refpurpose">Set the lower bound of a constraint</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setConstrLower</span><span class="default">(</span><span class="default">index</span><span class="default">,</span><span class="default">newBound</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This function changes the lower bound of a constraint</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">index</span> + <dd><p class="para">Index of the constraint to modify. Must be in {0,1,2,...n-1} where n is the number of constraints in the problem</p></dd></dt> + <dt><span class="term">newBound</span> + <dd><p class="para">The new lower bound for the constraint</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_setConstrLower</span><span class="scilabopenclose">(</span><span class="scilabnumber">2</span><span class="scilabdefault">,</span><span class="scilaboperator">-</span><span class="scilabnumber">100</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_resetParams.html"><< sym_resetParams</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setConstrType.html">sym_setConstrType >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setConstrType.html b/help/en_US/scilab_en_US_help/sym_setConstrType.html new file mode 100644 index 0000000..3c6a856 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setConstrType.html @@ -0,0 +1,91 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setConstrType</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setConstrLower.html"><< sym_setConstrLower</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setConstrUpper.html">sym_setConstrUpper >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setConstrType</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setConstrType</h1> + <p class="refpurpose">Set the type of a constraint</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setConstrType</span><span class="default">(</span><span class="default">index</span><span class="default">,</span><span class="default">type</span><span class="default">,</span><span class="default">bound1</span><span class="default">[,</span><span class="default">bound2</span><span class="default">])</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">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.</p> + <p class="para">The last argument is only required for ranged constraints. For the other types of constraints, only the third argument is required.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">index</span> + <dd><p class="para">Index of the constraint to modify. Must be in {0,1,2,...n-1} where n is the number of constraints in the problem</p></dd></dt> + <dt><span class="term">type</span> + <dd><p class="para">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")</p></dd></dt> + <dt><span class="term">bound1</span> + <dd><p class="para">The first (or only) bound for the constraint</p></dd></dt> + <dt><span class="term">bound2</span> + <dd><p class="para">The second bound for ranged constraints. The two bounds for ranged constraints can be in any order.</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_setConstrType</span><span class="scilabopenclose">(</span><span class="scilabnumber">2</span><span class="scilabdefault">,</span><span class="scilabstring">"</span><span class="scilabstring">R</span><span class="scilabstring">"</span><span class="scilabdefault">,</span><span class="scilaboperator">-</span><span class="scilabnumber">10</span><span class="scilabdefault">,</span><span class="scilabnumber">10</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div> + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_setConstrType</span><span class="scilabopenclose">(</span><span class="scilabnumber">3</span><span class="scilabdefault">,</span><span class="scilabstring">"</span><span class="scilabstring">E</span><span class="scilabstring">"</span><span class="scilabdefault">,</span><span class="scilabnumber">100</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setConstrLower.html"><< sym_setConstrLower</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setConstrUpper.html">sym_setConstrUpper >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setConstrUpper.html b/help/en_US/scilab_en_US_help/sym_setConstrUpper.html new file mode 100644 index 0000000..33d7a86 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setConstrUpper.html @@ -0,0 +1,85 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setConstrUpper</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setConstrType.html"><< sym_setConstrType</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setContinuous.html">sym_setContinuous >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setConstrUpper</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setConstrUpper</h1> + <p class="refpurpose">Set the upper bound of a constraint</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setConstrUpper</span><span class="default">(</span><span class="default">index</span><span class="default">,</span><span class="default">newBound</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This function changes the upper bound of a constraint</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">index</span> + <dd><p class="para">Index of the constraint to modify. Must be in {0,1,2,...n-1} where n is the number of constraints in the problem</p></dd></dt> + <dt><span class="term">newBound</span> + <dd><p class="para">The new upper bound for the constraint</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_setConstrUpper</span><span class="scilabopenclose">(</span><span class="scilabnumber">2</span><span class="scilabdefault">,</span><span class="scilaboperator">-</span><span class="scilabnumber">100</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setConstrType.html"><< sym_setConstrType</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setContinuous.html">sym_setContinuous >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setContinuous.html b/help/en_US/scilab_en_US_help/sym_setContinuous.html new file mode 100644 index 0000000..dd36be8 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setContinuous.html @@ -0,0 +1,81 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setContinuous</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setConstrUpper.html"><< sym_setConstrUpper</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setDblParam.html">sym_setDblParam >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setContinuous</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setContinuous</h1> + <p class="refpurpose">This routine is used to set the type of a variable to be continuous.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setContinuous</span><span class="default">(</span><span class="default">index</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">index</span> + <dd><p class="para">Index of the variable to be set continuous</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0 if the variable type has been set as continuous and 0 if an error value is returned.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_setContinuous</span><span class="scilabopenclose">(</span><span class="scilabnumber">1</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Iswarya Hariharan</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setConstrUpper.html"><< sym_setConstrUpper</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setDblParam.html">sym_setDblParam >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setDblParam.html b/help/en_US/scilab_en_US_help/sym_setDblParam.html new file mode 100644 index 0000000..2a5c383 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setDblParam.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setDblParam</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setContinuous.html"><< sym_setContinuous</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setIntParam.html">sym_setIntParam >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setDblParam</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setDblParam</h1> + <p class="refpurpose">This routine is used to set a double type parameter.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setDblParam</span><span class="default">(</span><span class="default">key</span><span class="default">,</span><span class="default">value</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">key</span> + <dd><p class="para">The name of the double type parameter to be set. Note: should be given within " "</p></dd></dt> + <dt><span class="term">value</span> + <dd><p class="para">New value of the corresponding double parameter</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_setDblParam</span><span class="scilabopenclose">(</span><span class="scilabstring">"</span><span class="scilabstring">time_limit</span><span class="scilabstring">"</span><span class="scilabdefault">,</span><span class="scilabnumber">5</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Iswarya Hariharan</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setContinuous.html"><< sym_setContinuous</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setIntParam.html">sym_setIntParam >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setIntParam.html b/help/en_US/scilab_en_US_help/sym_setIntParam.html new file mode 100644 index 0000000..5322cd0 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setIntParam.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setIntParam</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setDblParam.html"><< sym_setDblParam</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setInteger.html">sym_setInteger >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setIntParam</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setIntParam</h1> + <p class="refpurpose">This routine is used to set an integer type parameter.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setIntParam</span><span class="default">(</span><span class="default">key</span><span class="default">,</span><span class="default">value</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">key</span> + <dd><p class="para">The name of the parameter to be set. Note:should be given within " "</p></dd></dt> + <dt><span class="term">value</span> + <dd><p class="para">New value of the corresponding integer parameter</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_setIntParam</span><span class="scilabopenclose">(</span><span class="scilabstring">"</span><span class="scilabstring">verbosity</span><span class="scilabstring">"</span><span class="scilabdefault">,</span><span class="scilabnumber">5</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Iswarya Hariharan</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setDblParam.html"><< sym_setDblParam</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setInteger.html">sym_setInteger >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setInteger.html b/help/en_US/scilab_en_US_help/sym_setInteger.html new file mode 100644 index 0000000..7309e8e --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setInteger.html @@ -0,0 +1,81 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setInteger</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setIntParam.html"><< sym_setIntParam</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setObjCoeff.html">sym_setObjCoeff >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setInteger</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setInteger</h1> + <p class="refpurpose">This routine is used to set the type of a variable to be integer.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setInteger</span><span class="default">(</span><span class="default">index</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">index</span> + <dd><p class="para">The index of the variable type to be modified as integer. Note that, it has to be at most the number of columns.</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0 if the variable type has been set as integer and 0 if an error value is returned.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_setInteger</span><span class="scilabopenclose">(</span><span class="scilabnumber">1</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Iswarya Hariharan</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setIntParam.html"><< sym_setIntParam</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setObjCoeff.html">sym_setObjCoeff >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setObjCoeff.html b/help/en_US/scilab_en_US_help/sym_setObjCoeff.html new file mode 100644 index 0000000..07834b7 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setObjCoeff.html @@ -0,0 +1,85 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setObjCoeff</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setInteger.html"><< sym_setInteger</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setObjSense.html">sym_setObjSense >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setObjCoeff</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setObjCoeff</h1> + <p class="refpurpose">Set coefficient of a variable in the objective</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setObjCoeff</span><span class="default">(</span><span class="default">index</span><span class="default">,</span><span class="default">newCoeff</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This function changes the coefficient of a variable in the objective function</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">index</span> + <dd><p class="para">Index of the variable to modify. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</p></dd></dt> + <dt><span class="term">newCoeff</span> + <dd><p class="para">The new coefficient of the variable</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_setObjCoeff</span><span class="scilabopenclose">(</span><span class="scilabnumber">2</span><span class="scilabdefault">,</span><span class="scilabnumber">1.5</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setInteger.html"><< sym_setInteger</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setObjSense.html">sym_setObjSense >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setObjSense.html b/help/en_US/scilab_en_US_help/sym_setObjSense.html new file mode 100644 index 0000000..2c66491 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setObjSense.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setObjSense</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setObjCoeff.html"><< sym_setObjCoeff</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setPrimalBound.html">sym_setPrimalBound >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setObjSense</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setObjSense</h1> + <p class="refpurpose">Set the objective sense</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setObjSense</span><span class="default">(</span><span class="default">sense</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This function sets the sense of the objective function (minimization/maximization).</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">sense</span> + <dd><p class="para">The new sense of the objective function. Use sym_minimize or sym_maximize here</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_setObjSense</span><span class="scilabopenclose">(</span><span class="scilabid">sym_minimize</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setObjCoeff.html"><< sym_setObjCoeff</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setPrimalBound.html">sym_setPrimalBound >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setPrimalBound.html b/help/en_US/scilab_en_US_help/sym_setPrimalBound.html new file mode 100644 index 0000000..0771448 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setPrimalBound.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setPrimalBound</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setObjSense.html"><< sym_setObjSense</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setStrParam.html">sym_setStrParam >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setPrimalBound</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setPrimalBound</h1> + <p class="refpurpose">Set the primal bound of the problem</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setPrimalBound</span><span class="default">(</span><span class="default">bound</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">Set the primal bound of the loaded problem.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">bound</span> + <dd><p class="para">The new primal bound for the problem</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_setPrimalBound</span><span class="scilabopenclose">(</span><span class="scilabnumber">10</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setObjSense.html"><< sym_setObjSense</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setStrParam.html">sym_setStrParam >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setStrParam.html b/help/en_US/scilab_en_US_help/sym_setStrParam.html new file mode 100644 index 0000000..b98b52c --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setStrParam.html @@ -0,0 +1,83 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setStrParam</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setPrimalBound.html"><< sym_setPrimalBound</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setVarLower.html">sym_setVarLower >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setStrParam</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setStrParam</h1> + <p class="refpurpose">This routine is used to set a string type parameter.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setStrParam</span><span class="default">(</span><span class="default">key</span><span class="default">,</span><span class="default">value</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">key</span> + <dd><p class="para">The name of the string type parameter to be set. Note: should be given within " "</p></dd></dt> + <dt><span class="term">value</span> + <dd><p class="para">New value of the corresponding string parameter. Note: should be given within " "</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_setStrParam</span><span class="scilabopenclose">(</span><span class="scilabstring">"</span><span class="scilabstring">source_path</span><span class="scilabstring">"</span><span class="scilabdefault">,</span><span class="scilabstring">"</span><span class="scilabstring">.</span><span class="scilabstring">.</span><span class="scilabstring">"</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Iswarya Hariharan</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setPrimalBound.html"><< sym_setPrimalBound</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setVarLower.html">sym_setVarLower >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setVarLower.html b/help/en_US/scilab_en_US_help/sym_setVarLower.html new file mode 100644 index 0000000..4ec0155 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setVarLower.html @@ -0,0 +1,85 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setVarLower</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setStrParam.html"><< sym_setStrParam</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setVarSoln.html">sym_setVarSoln >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setVarLower</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setVarLower</h1> + <p class="refpurpose">Set lower bound of a variable</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setVarLower</span><span class="default">(</span><span class="default">index</span><span class="default">,</span><span class="default">newBound</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This function changes the lower bound of a variable to a new value</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">index</span> + <dd><p class="para">Index of the variable to modify. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</p></dd></dt> + <dt><span class="term">newBound</span> + <dd><p class="para">The new lower bound for the variable</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_setVarLower</span><span class="scilabopenclose">(</span><span class="scilabnumber">2</span><span class="scilabdefault">,</span><span class="scilaboperator">-</span><span class="scilabconstants">%inf</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setStrParam.html"><< sym_setStrParam</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setVarSoln.html">sym_setVarSoln >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setVarSoln.html b/help/en_US/scilab_en_US_help/sym_setVarSoln.html new file mode 100644 index 0000000..be0da1b --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setVarSoln.html @@ -0,0 +1,84 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setVarSoln</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setVarLower.html"><< sym_setVarLower</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setVarUpper.html">sym_setVarUpper >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setVarSoln</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setVarSoln</h1> + <p class="refpurpose">Set a solution for the problem</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setVarSoln</span><span class="default">(</span><span class="default">solution</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">Sets a known solution for the problem.</p> + <p class="para">This function fails if the solution entered does not satisfy all bounds or is worse than another currently known solution.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">solution</span> + <dd><p class="para">Matrix containing solutions for the variables (must have size 1 row and number of columns equal to number of variables)</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_setVarSoln</span><span class="scilabopenclose">(</span><span class="scilabopenclose">[</span><span class="scilabnumber">1</span><span class="scilabdefault">,</span><span class="scilabnumber">2</span><span class="scilabdefault">,</span><span class="scilabnumber">3.2</span><span class="scilabdefault">,</span><span class="scilabnumber">4</span><span class="scilabopenclose">]</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setVarLower.html"><< sym_setVarLower</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_setVarUpper.html">sym_setVarUpper >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_setVarUpper.html b/help/en_US/scilab_en_US_help/sym_setVarUpper.html new file mode 100644 index 0000000..a2a6561 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_setVarUpper.html @@ -0,0 +1,85 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_setVarUpper</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setVarSoln.html"><< sym_setVarSoln</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_solve.html">sym_solve >></a></span> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_setVarUpper</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_setVarUpper</h1> + <p class="refpurpose">Set upper bound of a variable</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_setVarUpper</span><span class="default">(</span><span class="default">index</span><span class="default">,</span><span class="default">newBound</span><span class="default">)</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This function changes the upper bound of a variable to a new value</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <dl><dt><span class="term">index</span> + <dd><p class="para">Index of the variable to modify. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</p></dd></dt> + <dt><span class="term">newBound</span> + <dd><p class="para">The new upper bound for the variable</p></dd></dt></dl></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">Returns 0</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">sym_setVarUpper</span><span class="scilabopenclose">(</span><span class="scilabnumber">2</span><span class="scilabdefault">,</span><span class="scilabnumber">100</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Keyur Joshi</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setVarSoln.html"><< sym_setVarSoln</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + <span class="next"><a href="sym_solve.html">sym_solve >></a></span> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/sym_solve.html b/help/en_US/scilab_en_US_help/sym_solve.html new file mode 100644 index 0000000..9d84212 --- /dev/null +++ b/help/en_US/scilab_en_US_help/sym_solve.html @@ -0,0 +1,81 @@ +<html><head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> + <title>sym_solve</title> + <style type="text/css" media="all"> + @import url("scilab_code.css"); + @import url("xml_code.css"); + @import url("c_code.css"); + @import url("style.css"); + </style> + </head> + <body> + <div class="manualnavbar"> + <table width="100%"><tr> + <td width="30%"> + <span class="previous"><a href="sym_setVarUpper.html"><< sym_setVarUpper</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + + + + <span class="path"><a href="index.html">Symphony Toolbox</a> >> <a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a> > sym_solve</span> + + <br /><br /> + <div class="refnamediv"><h1 class="refname">sym_solve</h1> + <p class="refpurpose">To solve the currently loaded MILP problem from scratch.</p></div> + + <div class="refsynopsisdiv"><h3 class="title">Calling Sequence</h3> + <div class="synopsis"><pre><span class="functionid">sym_solve</span><span class="default">()</span></pre></div></div> + + <div class="refsection"><h3 class="title">Description</h3> + + <p class="para">This routine solves the currently loaded MILP problem from scratch.</p> + <p class="para">It prints status of the problem solver to scilab console.</p></div> + + <div class="refsection"><h3 class="title">Arguments</h3> + + <p class="para">This function takes no arguments</p></div> + + <div class="refsection"><h3 class="title">Return value</h3> + + <p class="para">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.</p></div> + + <div class="refsection"><h3 class="title">Examples</h3> + + <div class="programlisting"><table border="0" width="100%"><tr><td width="98%"><pre class="scilabcode"><span class="scilabid">status</span><span class="scilaboperator">=</span><span class="scilabid">sym_solve</span><span class="scilabopenclose">(</span><span class="scilabopenclose">)</span></pre></td><td valign="top"><a href="scilab://scilab.execexample/"><img src="ScilabExecute.png" border="0"/></a></td><td valign="top"><a href="scilab://scilab.editexample/"><img src="ScilabEdit.png" border="0"/></a></td><td></td></tr></table></div></div> + + <div class="refsection"><h3 class="title">Authors</h3> + + <ul class="itemizedlist"><li class="member">Sai Kiran Naragam</li></ul></div> + <br /> + + <div class="manualnavbar"> + <table width="100%"> + <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr> +<tr> + <td width="30%"> + <span class="previous"><a href="sym_setVarUpper.html"><< sym_setVarUpper</a></span> + + </td> + <td width="40%" class="center"> + <span class="top"><a href="section_19f4f1e5726c01d683e8b82be0a7e910.html">Symphony Toolbox</a></span> + + </td> + <td width="30%" class="next"> + + </td> + </tr></table> + <hr /> + </div> + </body> +</html> diff --git a/help/en_US/scilab_en_US_help/xml_code.css b/help/en_US/scilab_en_US_help/xml_code.css new file mode 100644 index 0000000..9e4c27f --- /dev/null +++ b/help/en_US/scilab_en_US_help/xml_code.css @@ -0,0 +1,94 @@ +.xmlcomment { + font-style: italic; + color: #01a801 +} + +.xmldefault { + font-style: normal; + color: #000000 +} + +.xmlentity { + font-style: normal; + color: #ffaa00 +} + +.xmlopeninstr { + font-style: normal; + color: #000000 +} + +.xmlcloseinstr { + font-style: normal; + color: #000000 +} + +.xmlinstrname { + font-style: normal; + color: #9965a6 +} + +.xmllowtag { + font-style: normal; + color: #000000 +} + +.xmltagname { + font-style: normal; + color: #0303ff +} + +.xmllowclose { + font-style: normal; + color: #000000 +} + +.xmlopencomment { + font-style: italic; + color: #01a801 +} + +.xmlcommentend { + font-style: italic; + color: #01a801 +} + +.xmlcomment { + font-style: italic; + color: #01a801 +} + +.xmlopencdata { + font-style: normal; + color: #c45555 +} + +.xmlcdataend { + font-style: normal; + color: #c45555 +} + +.xmlcdata { + font-style: normal; + color: #000000 +} + +.xmlattributename { + font-style: normal; + color: #9965a6 +} + +.xmlequal { + font-style: normal; + color: #000000 +} + +.xmlattributevalue { + font-style: normal; + color: #973964 +} + +.xmlautoclose { + font-style: normal; + color: #000000 +} diff --git a/help/en_US/sym_addConstr.xml b/help/en_US/sym_addConstr.xml new file mode 100644 index 0000000..89ec114 --- /dev/null +++ b/help/en_US/sym_addConstr.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_addConstr" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_addConstr</refname> + <refpurpose>Add a new constraint</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_addConstr(coeff,type,bound1[,bound2])</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>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.</para> + <para>The last argument is only required for ranged constraints. For the other types of constraints, only the third argument is required.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>coeff</term> + <listitem><para>Sparse matrix representing coefficients of the variables in the new constraint (must have 1 row and number of columns equal to number of variables)</para></listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem><para>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")</para></listitem> + </varlistentry> + <varlistentry> + <term>bound1</term> + <listitem><para>The first (or only) bound for the constraint</para></listitem> + </varlistentry> + <varlistentry> + <term>bound2</term> + <listitem><para>The second bound for ranged constraints. The two bounds for ranged constraints can be in any order.</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_addConstr(sparse([0,0,1,0,2]),"R",0,10)</programlisting> + <programlisting role="example">sym_addConstr(sparse([0,0,1,1,0]),"G",4)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_addVar.xml b/help/en_US/sym_addVar.xml new file mode 100644 index 0000000..7ba5c74 --- /dev/null +++ b/help/en_US/sym_addVar.xml @@ -0,0 +1,82 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_addVar" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_addVar</refname> + <refpurpose>Add a new variable</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_addVar(coeff,lower,upper,obj,isInt,name)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function adds a new variable from scratch.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>coeff</term> + <listitem><para>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)</para></listitem> + </varlistentry> + <varlistentry> + <term>lower</term> + <listitem><para>Lower bound of the new variable</para></listitem> + </varlistentry> + <varlistentry> + <term>upper</term> + <listitem><para>Upper bound of the new variable</para></listitem> + </varlistentry> + <varlistentry> + <term>obj</term> + <listitem><para>Coefficient of the variable in the objective function</para></listitem> + </varlistentry> + <varlistentry> + <term>isInt</term> + <listitem><para>Wether the variable is constrainted to be an integer (boolean %t or %f)</para></listitem> + </varlistentry> + <varlistentry> + <term>name</term> + <listitem><para>Name of the new variable</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_addVar(sparse([0;0;1;2;0;0]),0,%inf,1.2,%t,"part1")</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_close.xml b/help/en_US/sym_close.xml new file mode 100644 index 0000000..5f2e903 --- /dev/null +++ b/help/en_US/sym_close.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_close" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_close</refname> + <refpurpose>Close the Symphony environment</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_close()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Closes the already open Symphony environment.</para> + <para>Warning: All data loaded into the environment is deleted.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 1 if the environment was successfully closed and 0 otherwise</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_close()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + <member>Iswarya</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_deleteConstrs.xml b/help/en_US/sym_deleteConstrs.xml new file mode 100644 index 0000000..7c1aaa7 --- /dev/null +++ b/help/en_US/sym_deleteConstrs.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_deleteConstrs" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_deleteConstrs</refname> + <refpurpose>This routine is used to delete rows from the original constraint matrix.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_deleteConstrs(indices)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>indices</term> + <listitem><para>An array indicating the indices of the rows to be deleted.</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the constraints specified in the indices are deleted successfully and 0 if it returns corresponding to an error value.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_deleteConstrs([1,2])</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_deleteVars.xml b/help/en_US/sym_deleteVars.xml new file mode 100644 index 0000000..3ce1fe7 --- /dev/null +++ b/help/en_US/sym_deleteVars.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_deleteVars" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_deleteVars</refname> + <refpurpose>This routine is used to delete columns from the original problem description.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_deleteVars(indices)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>indices</term> + <listitem><para>Pointer to an integer type array indicating the indices of the column numbers(variables) to be deleted.</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_deleteVars([1,2])</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getConstrActivity.xml b/help/en_US/sym_getConstrActivity.xml new file mode 100644 index 0000000..7323a48 --- /dev/null +++ b/help/en_US/sym_getConstrActivity.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getConstrActivity" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getConstrActivity</refname> + <refpurpose>Get the activity of the constraints in the solution</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getConstrActivity()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Get the activity of the constraints in the solution.</para> + <para>This function may fail if the problem has not been solved already. Use sym_solve() in this case.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns a matrix with 1 column and number of rows equal to number of constraints, that represents the activities of those constraints</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_getConstrActivity()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getConstrLower.xml b/help/en_US/sym_getConstrLower.xml new file mode 100644 index 0000000..8274813 --- /dev/null +++ b/help/en_US/sym_getConstrLower.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getConstrLower" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getConstrLower</refname> + <refpurpose>To get the lower bounds of the constraints.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getConstrLower()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get lower bounds of constraints.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a column vector of lower bounds of constraints.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getConstrLower()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getConstrRange.xml b/help/en_US/sym_getConstrRange.xml new file mode 100644 index 0000000..402f313 --- /dev/null +++ b/help/en_US/sym_getConstrRange.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getConstrRange" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getConstrRange</refname> + <refpurpose>To to get the constraint ranges.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getConstrRange()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the constraint ranges.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a column vector of the constraint ranges.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getConstrRange()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getConstrSense.xml b/help/en_US/sym_getConstrSense.xml new file mode 100644 index 0000000..85d358c --- /dev/null +++ b/help/en_US/sym_getConstrSense.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getConstrSense" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getConstrSense</refname> + <refpurpose>To get the row senses.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getConstrSense()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the row senses.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a column vector of the row senses.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getConstrSense()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getConstrUpper.xml b/help/en_US/sym_getConstrUpper.xml new file mode 100644 index 0000000..5422d96 --- /dev/null +++ b/help/en_US/sym_getConstrUpper.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getConstrUpper" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getConstrUpper</refname> + <refpurpose>To get the upper bounds of the constraints.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getConstrUpper()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get upper bounds of the constraints.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a column vector of upper bounds of constraints.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getConstrUpper()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getDblParam.xml b/help/en_US/sym_getDblParam.xml new file mode 100644 index 0000000..4e5d8f3 --- /dev/null +++ b/help/en_US/sym_getDblParam.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getDblParam" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getDblParam</refname> + <refpurpose>This routine is used to get the value of a double type parameter.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getDblParam(key)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>key</term> + <listitem><para>The name of the double parameter whose value has to be retrieved. Note: should be given within " "</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_getDblParam("time_limit")</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getInfinity.xml b/help/en_US/sym_getInfinity.xml new file mode 100644 index 0000000..295fd17 --- /dev/null +++ b/help/en_US/sym_getInfinity.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getInfinity" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getInfinity</refname> + <refpurpose>Get Symphony's infinity value</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getInfinity()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Get the value that Symphony considers to be infinity. This is equal to 10^20.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns the infinity value of Symphony</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_getInfinity()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getIntParam.xml b/help/en_US/sym_getIntParam.xml new file mode 100644 index 0000000..a6626af --- /dev/null +++ b/help/en_US/sym_getIntParam.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getIntParam" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getIntParam</refname> + <refpurpose>This routine is used to get the value of an integer type parameter.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getIntParam(key)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>key</term> + <listitem><para>The name of the integer parameter whose value has to be retrieved. Note: should be given within " "</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_getIntParam("verbosity")</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getIterCount.xml b/help/en_US/sym_getIterCount.xml new file mode 100644 index 0000000..ab7f42e --- /dev/null +++ b/help/en_US/sym_getIterCount.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getIterCount" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getIterCount</refname> + <refpurpose>To get the number of the analyzed nodes of the branching tree after solving the problem.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getIterCount()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the number of the analyzed nodes of the branching tree after solving the problem.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns iteration count.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getIterCount()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getMatrix.xml b/help/en_US/sym_getMatrix.xml new file mode 100644 index 0000000..fbcd87f --- /dev/null +++ b/help/en_US/sym_getMatrix.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getMatrix" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getMatrix</refname> + <refpurpose>To get the constraint matrix.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getMatrix()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the constraint matrix as sparse matrix in a standard row-ordered format.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a row-ordered sparse matrix.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getMatrix()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getNumConstr.xml b/help/en_US/sym_getNumConstr.xml new file mode 100644 index 0000000..63715fb --- /dev/null +++ b/help/en_US/sym_getNumConstr.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getNumConstr" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getNumConstr</refname> + <refpurpose>To get the number of the constraints of the current problem.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getNumConstr()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the number of the constraints of the current problem.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getNumConstr()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getNumElements.xml b/help/en_US/sym_getNumElements.xml new file mode 100644 index 0000000..5ce71a9 --- /dev/null +++ b/help/en_US/sym_getNumElements.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getNumElements" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getNumElements</refname> + <refpurpose>To get the number of non-zero entries of the constraint matrix of the current problem.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getNumElements()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the number of non-zero entries of the constraint matrix of the current problem.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getNumElements()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getNumVar.xml b/help/en_US/sym_getNumVar.xml new file mode 100644 index 0000000..5602811 --- /dev/null +++ b/help/en_US/sym_getNumVar.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getNumVar" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getNumVar</refname> + <refpurpose>To get the number of the variables of the current problem.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getNumVar()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the number of the variables of the current problem.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getNumVar()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getObjCoeff.xml b/help/en_US/sym_getObjCoeff.xml new file mode 100644 index 0000000..194d3cd --- /dev/null +++ b/help/en_US/sym_getObjCoeff.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getObjCoeff" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getObjCoeff</refname> + <refpurpose>To get the objective vector.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getObjCoeff()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the objective vector.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a row vector of coefficients of variables in objective.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getObjCoeff()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getObjSense.xml b/help/en_US/sym_getObjSense.xml new file mode 100644 index 0000000..1d4f0fa --- /dev/null +++ b/help/en_US/sym_getObjSense.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getObjSense" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getObjSense</refname> + <refpurpose>Get the objective sense</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getObjSense()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function gets the sense of the objective function (minimization/maximization).</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 1 if the objective is to be minimized and -1 if the objective is to be maximized</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_getObjSense()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getObjVal.xml b/help/en_US/sym_getObjVal.xml new file mode 100644 index 0000000..9a65646 --- /dev/null +++ b/help/en_US/sym_getObjVal.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getObjVal" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getObjVal</refname> + <refpurpose>Get the optimized objective value</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getObjVal()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Get the optimized objective value after after solving the problem.</para> + <para>This function may fail if the problem has not been solved already. Use sym_solve() in this case.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns the optimized objective value</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_getObjVal()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getPrimalBound.xml b/help/en_US/sym_getPrimalBound.xml new file mode 100644 index 0000000..3b9db8d --- /dev/null +++ b/help/en_US/sym_getPrimalBound.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getPrimalBound" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getPrimalBound</refname> + <refpurpose>Get the primal bound of the problem</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getPrimalBound()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Get the primal bound of the loaded problem.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns the primal bound of the problem</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_getPrimalBound()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getRhs.xml b/help/en_US/sym_getRhs.xml new file mode 100644 index 0000000..a0d1a76 --- /dev/null +++ b/help/en_US/sym_getRhs.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getRhs" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getRhs</refname> + <refpurpose>To to get the right hand side vector(column vector).</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getRhs()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the right hand side vector(coumn vector).</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a column vector of the right hand side values of constraints.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getRhs()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getStatus.xml b/help/en_US/sym_getStatus.xml new file mode 100644 index 0000000..f13e59e --- /dev/null +++ b/help/en_US/sym_getStatus.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getStatus" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getStatus</refname> + <refpurpose>To get status of the problem solver.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getStatus()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn the termination status of the solution procedure.</para> + <para>It prints status of the problem solver to scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_getStatus()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getStrParam.xml b/help/en_US/sym_getStrParam.xml new file mode 100644 index 0000000..b261053 --- /dev/null +++ b/help/en_US/sym_getStrParam.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getStrParam" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getStrParam</refname> + <refpurpose>This routine is used to get the value of a string type parameter.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getStrParam(key)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>key</term> + <listitem><para>The name of the strung parameter whose value has to be retrieved. Note: should be given within " "</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_getStrParam("source_path")</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getVarLower.xml b/help/en_US/sym_getVarLower.xml new file mode 100644 index 0000000..771d095 --- /dev/null +++ b/help/en_US/sym_getVarLower.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getVarLower" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getVarLower</refname> + <refpurpose>To get the lower bounds of the variables.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getVarLower()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the lower bounds of the variables.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a row vector of lower bounds of the variables.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getVarLower()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getVarSoln.xml b/help/en_US/sym_getVarSoln.xml new file mode 100644 index 0000000..5500c57 --- /dev/null +++ b/help/en_US/sym_getVarSoln.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getVarSoln" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getVarSoln</refname> + <refpurpose>Get the solution for the problem</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getVarSoln()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Get the solution for the problem after solving it.</para> + <para>This function may fail if the problem has not been solved already. Use sym_solve() in this case.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns a matrix with 1 row and number of columns equal to number of variables, that represents the solutions for those variables</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_getVarSoln()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_getVarUpper.xml b/help/en_US/sym_getVarUpper.xml new file mode 100644 index 0000000..a447a54 --- /dev/null +++ b/help/en_US/sym_getVarUpper.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_getVarUpper" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_getVarUpper</refname> + <refpurpose>To get the upper bounds of the variables.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_getVarUpper()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine is used to get the upper bounds of the variables.</para> + <para>If there was an error it prints to Scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns a row vector of upper bounds of the variables.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">ans=sym_getVarUpper()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_isAbandoned.xml b/help/en_US/sym_isAbandoned.xml new file mode 100644 index 0000000..1009201 --- /dev/null +++ b/help/en_US/sym_isAbandoned.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isAbandoned" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_isAbandoned</refname> + <refpurpose>To check whether the problem was abandoned for some reason.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isAbandoned()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn whether the problem was abandoned for some reason.</para> + <para>It prints whether or not the problem was abandoned for some reason to scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>It returns 1 if the problem was abandoned or 0 if the problem was not abandoned or -1 if there was an error.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_isAbandoned()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_isBinary.xml b/help/en_US/sym_isBinary.xml new file mode 100644 index 0000000..57a6cf3 --- /dev/null +++ b/help/en_US/sym_isBinary.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isBinary" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_isBinary</refname> + <refpurpose>Check if a variable is constrained to be binary</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isBinary(index)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function checks if a variable is constrained to be binary (0 or 1).</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the variable to check. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 1 if the variable is constrained to be binary and 0 if it is not.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_isBinary(2)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_isContinuous.xml b/help/en_US/sym_isContinuous.xml new file mode 100644 index 0000000..8c6a77b --- /dev/null +++ b/help/en_US/sym_isContinuous.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isContinuous" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_isContinuous</refname> + <refpurpose>Check if a variable is continuous</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isContinuous(index)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function checks if a variable is continuous.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the variable to check. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 1 if the variable is continuous and 0 if it is not.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_isContinuous(2)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_isEnvActive.xml b/help/en_US/sym_isEnvActive.xml new file mode 100644 index 0000000..b47e28b --- /dev/null +++ b/help/en_US/sym_isEnvActive.xml @@ -0,0 +1,57 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isEnvActive" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_isEnvActive</refname> + <refpurpose>Check if Symphony environment is active</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isEnvActive()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Check if Symphony environment is active (open). Most Symphony functions will require the environment to be open.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 1 if the environment is active and 0 otherwise</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_isEnvActive()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_isInfeasible.xml b/help/en_US/sym_isInfeasible.xml new file mode 100644 index 0000000..88a4f43 --- /dev/null +++ b/help/en_US/sym_isInfeasible.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isInfeasible" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_isInfeasible</refname> + <refpurpose>To check whether the problem was proven to be infeasible.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isInfeasible()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn whether the problem was proven to be infeasible.</para> + <para>It prints whether or not the problem was proven to be infeasible to scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_isInfeasible()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_isInteger.xml b/help/en_US/sym_isInteger.xml new file mode 100644 index 0000000..e104039 --- /dev/null +++ b/help/en_US/sym_isInteger.xml @@ -0,0 +1,46 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isInteger" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_isInteger</refname> + + <refpurpose>Check if a variable is constrained to be an integer</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + + <synopsis>sym_isInteger(index)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function checks if a variable is constrained to be an integer.</para> + <para>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</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_isInteger(2)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_isIterLimitReached.xml b/help/en_US/sym_isIterLimitReached.xml new file mode 100644 index 0000000..013f984 --- /dev/null +++ b/help/en_US/sym_isIterLimitReached.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isIterLimitReached" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_isIterLimitReached</refname> + <refpurpose>To know whether the iteration limit (node limit) was reached.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isIterLimitReached()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn whether the iteration limit(node limit) was reached.</para> + <para>It prints whether or not the iteration limit (node limit) was reached to scilab console.</para> + <para>It can also be used if "find first feasible" parameter was set to true before solving the problem.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_isIterLimitReached()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_isOptimal.xml b/help/en_US/sym_isOptimal.xml new file mode 100644 index 0000000..889aa02 --- /dev/null +++ b/help/en_US/sym_isOptimal.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isOptimal" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_isOptimal</refname> + <refpurpose>To check whether the problem was solved to optimality.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isOptimal()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn whether the problem was solved to</para> + <para>optimality.</para> + <para>It prints whether or not the problem was solved to optimality to scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_isOptimal()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_isTargetGapAchieved.xml b/help/en_US/sym_isTargetGapAchieved.xml new file mode 100644 index 0000000..81c99b4 --- /dev/null +++ b/help/en_US/sym_isTargetGapAchieved.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isTargetGapAchieved" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_isTargetGapAchieved</refname> + <refpurpose>To know whether the target gap was reached.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isTargetGapAchieved()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn whether the target gap was reached.</para> + <para>It print whether or not the target gap was reached.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_isTargetGapAchieved()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_isTimeLimitReached.xml b/help/en_US/sym_isTimeLimitReached.xml new file mode 100644 index 0000000..42889de --- /dev/null +++ b/help/en_US/sym_isTimeLimitReached.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_isTimeLimitReached" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_isTimeLimitReached</refname> + <refpurpose>To know whether the time limit was reached.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_isTimeLimitReached()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This post-solution query routine is used to learn whether the time limit was reached.</para> + <para>It prints whether or not the time limit was reached to scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_isTimeLimitReached()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_loadMPS.xml b/help/en_US/sym_loadMPS.xml new file mode 100644 index 0000000..6e55cff --- /dev/null +++ b/help/en_US/sym_loadMPS.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_loadMPS" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_loadMPS</refname> + <refpurpose>This routine is used to load an instance from an MPS file.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_loadMPS(filename)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>filename</term> + <listitem><para>It is a string that has the path of the .mps file to loaded.It has to be given within double quotes ("")</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_loadMPS("./sample.mps") -mps file present in the current directory of execution can be mentioned this way also</programlisting> + <programlisting role="example">status=sym_loadMPS("/home/Desktop/sample.mps") -mps file present at a different location must be specified with their entire path</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_loadProblem.xml b/help/en_US/sym_loadProblem.xml new file mode 100644 index 0000000..e2409c5 --- /dev/null +++ b/help/en_US/sym_loadProblem.xml @@ -0,0 +1,99 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_loadProblem" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_loadProblem</refname> + <refpurpose>Load a problem into Symphony</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_loadProblem(nbVar,nbConstr,varLB,varUB,objCoeff,isInt,objSense,conMatrix,conLB,conUB)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Loads a MIP problem into Symphony. All the necessary data can be given through a single function call.</para> + <para>The type of constraint is automatically deduced from the constraint bounds.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>nbVar</term> + <listitem><para>Number of variables</para></listitem> + </varlistentry> + <varlistentry> + <term>nbConstr</term> + <listitem><para>Number of constraints</para></listitem> + </varlistentry> + <varlistentry> + <term>varLB</term> + <listitem><para>Matrix containing lower bounds of the variables (must have size 1 row and nbVar columns). Bound can be negative infinity</para></listitem> + </varlistentry> + <varlistentry> + <term>varUB</term> + <listitem><para>Matrix containing upper bounds of the variables (must have size 1 row and nbVar columns). Bound can be infinity</para></listitem> + </varlistentry> + <varlistentry> + <term>objCoeff</term> + <listitem><para>Matrix containing coefficients of the variables in the objective (must have size 1 row and nbVar columns)</para></listitem> + </varlistentry> + <varlistentry> + <term>isInt</term> + <listitem><para>Boolean matrix representing wether a variable is constrained to be an integer (must have size 1 row and nbVar columns)</para></listitem> + </varlistentry> + <varlistentry> + <term>objSense</term> + <listitem><para>The sense (maximization/minimization) of the objective. Use sym_minimize or sym_maximize here</para></listitem> + </varlistentry> + <varlistentry> + <term>conMatrix</term> + <listitem><para>Sparse matrix representing the constraint matrix (must have size nbConstr rows and nbVar columns)</para></listitem> + </varlistentry> + <varlistentry> + <term>conLB</term> + <listitem><para>Matrix containing lower bounds of the constraints (must have size nbConstr rows and 1 column)</para></listitem> + </varlistentry> + <varlistentry> + <term>conUB</term> + <listitem><para>Matrix containing upper bounds of the constraints (must have size nbConstr rows and 1 column)</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the problem was successfully loaded into Symphony</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_loadProblem(2,2,[0,0],[%inf,%inf],[1,1],[%t,%t],sym_maximize,sparse([1,2;2,1]),[0;0],[7;6.5])</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_loadProblemBasic.xml b/help/en_US/sym_loadProblemBasic.xml new file mode 100644 index 0000000..90a5995 --- /dev/null +++ b/help/en_US/sym_loadProblemBasic.xml @@ -0,0 +1,100 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_loadProblemBasic" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_loadProblemBasic</refname> + <refpurpose>Load a problem into Symphony (basic version)</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_loadProblemBasic(nbVar,nbConstr,varLB,varUB,objCoeff,isInt,objSense,conMatrix,conLB,conUB)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Loads a MIP problem into Symphony. All the necessary data can be given through a single function call.</para> + <para>The type of constraint is automatically deduced from the constraint bounds.</para> + <para>This version of the problem loader does not support sparse matrices and hence is only useful for small problems.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>nbVar</term> + <listitem><para>Number of variables</para></listitem> + </varlistentry> + <varlistentry> + <term>nbConstr</term> + <listitem><para>Number of constraints</para></listitem> + </varlistentry> + <varlistentry> + <term>varLB</term> + <listitem><para>Matrix containing lower bounds of the variables (must have size 1 row and nbVar columns). Bound can be negative infinity</para></listitem> + </varlistentry> + <varlistentry> + <term>varUB</term> + <listitem><para>Matrix containing upper bounds of the variables (must have size 1 row and nbVar columns). Bound can be infinity</para></listitem> + </varlistentry> + <varlistentry> + <term>objCoeff</term> + <listitem><para>Matrix containing coefficients of the variables in the objective (must have size 1 row and nbVar columns)</para></listitem> + </varlistentry> + <varlistentry> + <term>isInt</term> + <listitem><para>Boolean matrix representing wether a variable is constrained to be an integer (must have size 1 row and nbVar columns)</para></listitem> + </varlistentry> + <varlistentry> + <term>objSense</term> + <listitem><para>The sense (maximization/minimization) of the objective. Use sym_minimize or sym_maximize here</para></listitem> + </varlistentry> + <varlistentry> + <term>conMatrix</term> + <listitem><para>Matrix (normal) representing the constraint matrix (must have size nbConstr rows and nbVar columns)</para></listitem> + </varlistentry> + <varlistentry> + <term>conLB</term> + <listitem><para>Matrix containing lower bounds of the constraints (must have size nbConstr rows and 1 column)</para></listitem> + </varlistentry> + <varlistentry> + <term>conUB</term> + <listitem><para>Matrix containing upper bounds of the constraints (must have size nbConstr rows and 1 column)</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the problem was successfully loaded into Symphony</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_loadProblemBasic(2,2,[0,0],[%inf,%inf],[1,1],[%t,%t],sym_maximize,[1,2;2,1],[0;0],[7;6.5])</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_open.xml b/help/en_US/sym_open.xml new file mode 100644 index 0000000..92b3dec --- /dev/null +++ b/help/en_US/sym_open.xml @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_open" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_open</refname> + <refpurpose>Open the Symphony environment</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_open()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Opens the Symphony environment. The environment and all data loaded into it is maintained across function calls.</para> + <para>This function fails if the environment is already open.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 1 if the environment was successfully opened and 0 otherwise</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_open()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + <member>Iswarya</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_resetParams.xml b/help/en_US/sym_resetParams.xml new file mode 100644 index 0000000..a73fdbd --- /dev/null +++ b/help/en_US/sym_resetParams.xml @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_resetParams" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_resetParams</refname> + <refpurpose>This routine sets all the environment variables and parameters to their default values.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_resetParams()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_resetParams()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setConstrLower.xml b/help/en_US/sym_setConstrLower.xml new file mode 100644 index 0000000..ae68046 --- /dev/null +++ b/help/en_US/sym_setConstrLower.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setConstrLower" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setConstrLower</refname> + <refpurpose>Set the lower bound of a constraint</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setConstrLower(index,newBound)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function changes the lower bound of a constraint</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the constraint to modify. Must be in {0,1,2,...n-1} where n is the number of constraints in the problem</para></listitem> + </varlistentry> + <varlistentry> + <term>newBound</term> + <listitem><para>The new lower bound for the constraint</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setConstrLower(2,-100)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setConstrType.xml b/help/en_US/sym_setConstrType.xml new file mode 100644 index 0000000..18afed0 --- /dev/null +++ b/help/en_US/sym_setConstrType.xml @@ -0,0 +1,76 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setConstrType" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setConstrType</refname> + <refpurpose>Set the type of a constraint</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setConstrType(index,type,bound1[,bound2])</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>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.</para> + <para>The last argument is only required for ranged constraints. For the other types of constraints, only the third argument is required.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the constraint to modify. Must be in {0,1,2,...n-1} where n is the number of constraints in the problem</para></listitem> + </varlistentry> + <varlistentry> + <term>type</term> + <listitem><para>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")</para></listitem> + </varlistentry> + <varlistentry> + <term>bound1</term> + <listitem><para>The first (or only) bound for the constraint</para></listitem> + </varlistentry> + <varlistentry> + <term>bound2</term> + <listitem><para>The second bound for ranged constraints. The two bounds for ranged constraints can be in any order.</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setConstrType(2,"R",-10,10)</programlisting> + <programlisting role="example">sym_setConstrType(3,"E",100)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setConstrUpper.xml b/help/en_US/sym_setConstrUpper.xml new file mode 100644 index 0000000..676454c --- /dev/null +++ b/help/en_US/sym_setConstrUpper.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setConstrUpper" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setConstrUpper</refname> + <refpurpose>Set the upper bound of a constraint</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setConstrUpper(index,newBound)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function changes the upper bound of a constraint</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the constraint to modify. Must be in {0,1,2,...n-1} where n is the number of constraints in the problem</para></listitem> + </varlistentry> + <varlistentry> + <term>newBound</term> + <listitem><para>The new upper bound for the constraint</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setConstrUpper(2,-100)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setContinuous.xml b/help/en_US/sym_setContinuous.xml new file mode 100644 index 0000000..f4948d9 --- /dev/null +++ b/help/en_US/sym_setContinuous.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setContinuous" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setContinuous</refname> + <refpurpose>This routine is used to set the type of a variable to be continuous.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setContinuous(index)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the variable to be set continuous</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the variable type has been set as continuous and 0 if an error value is returned.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_setContinuous(1)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setDblParam.xml b/help/en_US/sym_setDblParam.xml new file mode 100644 index 0000000..464d29e --- /dev/null +++ b/help/en_US/sym_setDblParam.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setDblParam" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setDblParam</refname> + <refpurpose>This routine is used to set a double type parameter.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setDblParam(key,value)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>key</term> + <listitem><para>The name of the double type parameter to be set. Note: should be given within " "</para></listitem> + </varlistentry> + <varlistentry> + <term>value</term> + <listitem><para>New value of the corresponding double parameter</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_setDblParam("time_limit",5)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setIntParam.xml b/help/en_US/sym_setIntParam.xml new file mode 100644 index 0000000..e20dfb5 --- /dev/null +++ b/help/en_US/sym_setIntParam.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setIntParam" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setIntParam</refname> + <refpurpose>This routine is used to set an integer type parameter.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setIntParam(key,value)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>key</term> + <listitem><para>The name of the parameter to be set. Note:should be given within " "</para></listitem> + </varlistentry> + <varlistentry> + <term>value</term> + <listitem><para>New value of the corresponding integer parameter</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_setIntParam("verbosity",5)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setInteger.xml b/help/en_US/sym_setInteger.xml new file mode 100644 index 0000000..cebb83f --- /dev/null +++ b/help/en_US/sym_setInteger.xml @@ -0,0 +1,61 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setInteger" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setInteger</refname> + <refpurpose>This routine is used to set the type of a variable to be integer.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setInteger(index)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>The index of the variable type to be modified as integer. Note that, it has to be at most the number of columns.</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0 if the variable type has been set as integer and 0 if an error value is returned.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_setInteger(1)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setObjCoeff.xml b/help/en_US/sym_setObjCoeff.xml new file mode 100644 index 0000000..5251b4c --- /dev/null +++ b/help/en_US/sym_setObjCoeff.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setObjCoeff" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setObjCoeff</refname> + <refpurpose>Set coefficient of a variable in the objective</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setObjCoeff(index,newCoeff)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function changes the coefficient of a variable in the objective function</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the variable to modify. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</para></listitem> + </varlistentry> + <varlistentry> + <term>newCoeff</term> + <listitem><para>The new coefficient of the variable</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setObjCoeff(2,1.5)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setObjSense.xml b/help/en_US/sym_setObjSense.xml new file mode 100644 index 0000000..356ea97 --- /dev/null +++ b/help/en_US/sym_setObjSense.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setObjSense" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setObjSense</refname> + <refpurpose>Set the objective sense</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setObjSense(sense)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function sets the sense of the objective function (minimization/maximization).</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>sense</term> + <listitem><para>The new sense of the objective function. Use sym_minimize or sym_maximize here</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setObjSense(sym_minimize)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setPrimalBound.xml b/help/en_US/sym_setPrimalBound.xml new file mode 100644 index 0000000..c2f29a7 --- /dev/null +++ b/help/en_US/sym_setPrimalBound.xml @@ -0,0 +1,62 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setPrimalBound" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setPrimalBound</refname> + <refpurpose>Set the primal bound of the problem</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setPrimalBound(bound)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Set the primal bound of the loaded problem.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>bound</term> + <listitem><para>The new primal bound for the problem</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setPrimalBound(10)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setStrParam.xml b/help/en_US/sym_setStrParam.xml new file mode 100644 index 0000000..09c5ea8 --- /dev/null +++ b/help/en_US/sym_setStrParam.xml @@ -0,0 +1,65 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setStrParam" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setStrParam</refname> + <refpurpose>This routine is used to set a string type parameter.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setStrParam(key,value)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>key</term> + <listitem><para>The name of the string type parameter to be set. Note: should be given within " "</para></listitem> + </varlistentry> + <varlistentry> + <term>value</term> + <listitem><para>New value of the corresponding string parameter. Note: should be given within " "</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_setStrParam("source_path","..")</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Iswarya Hariharan</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setVarLower.xml b/help/en_US/sym_setVarLower.xml new file mode 100644 index 0000000..1f24813 --- /dev/null +++ b/help/en_US/sym_setVarLower.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setVarLower" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setVarLower</refname> + <refpurpose>Set lower bound of a variable</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setVarLower(index,newBound)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function changes the lower bound of a variable to a new value</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the variable to modify. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</para></listitem> + </varlistentry> + <varlistentry> + <term>newBound</term> + <listitem><para>The new lower bound for the variable</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setVarLower(2,-%inf)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setVarSoln.xml b/help/en_US/sym_setVarSoln.xml new file mode 100644 index 0000000..5fe6f3c --- /dev/null +++ b/help/en_US/sym_setVarSoln.xml @@ -0,0 +1,63 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setVarSoln" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setVarSoln</refname> + <refpurpose>Set a solution for the problem</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setVarSoln(solution)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>Sets a known solution for the problem.</para> + <para>This function fails if the solution entered does not satisfy all bounds or is worse than another currently known solution.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>solution</term> + <listitem><para>Matrix containing solutions for the variables (must have size 1 row and number of columns equal to number of variables)</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setVarSoln([1,2,3.2,4])</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_setVarUpper.xml b/help/en_US/sym_setVarUpper.xml new file mode 100644 index 0000000..286c45f --- /dev/null +++ b/help/en_US/sym_setVarUpper.xml @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_setVarUpper" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_setVarUpper</refname> + <refpurpose>Set upper bound of a variable</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_setVarUpper(index,newBound)</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This function changes the upper bound of a variable to a new value</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <variablelist> + <varlistentry> + <term>index</term> + <listitem><para>Index of the variable to modify. Must be in {0,1,2,...n-1} where n is the number of variables in the problem</para></listitem> + </varlistentry> + <varlistentry> + <term>newBound</term> + <listitem><para>The new upper bound for the variable</para></listitem> + </varlistentry> + </variablelist> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>Returns 0</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">sym_setVarUpper(2,100)</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Keyur Joshi</member> + + </simplelist> + </refsection> +</refentry> + diff --git a/help/en_US/sym_solve.xml b/help/en_US/sym_solve.xml new file mode 100644 index 0000000..587b26a --- /dev/null +++ b/help/en_US/sym_solve.xml @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="UTF-8"?> +<refentry version="5.0-subset Scilab" xml:id="sym_solve" xml:lang="en" + xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns:ns3="http://www.w3.org/1999/xhtml" + xmlns:mml="http://www.w3.org/1998/Math/MathML" + xmlns:db="http://docbook.org/ns/docbook"> + + <refnamediv> + <refname>sym_solve</refname> + <refpurpose>To solve the currently loaded MILP problem from scratch.</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <title>Calling Sequence</title> + <synopsis>sym_solve()</synopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>This routine solves the currently loaded MILP problem from scratch.</para> + <para>It prints status of the problem solver to scilab console.</para> + + </refsection> + + <refsection> + <title>Arguments</title> + + <para>This function takes no arguments</para> + + </refsection> + + <refsection> + <title>Return value</title> + + <para>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.</para> + + </refsection> + + <refsection> + <title>Examples</title> + + <programlisting role="example">status=sym_solve()</programlisting> + + </refsection> + + <refsection> + <title>Authors</title> + + <simplelist type="vert"> + <member>Sai Kiran Naragam</member> + + </simplelist> + </refsection> +</refentry> + |
