summaryrefslogtreecommitdiff
path: root/help/en_US/Symphony Native Function/sym_loadProblemBasic.xml
blob: 90a5995998feddaee25e5eb8b68ba8642b7c18f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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>