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