summaryrefslogtreecommitdiff
path: root/help/en_US/Symphony Native Function/sym_addVar.xml
blob: 7ba5c747088e5e3837362203a878b361c92d8f54 (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
<?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>