blob: 013f984d1a189de01beecd73f6d2fe7163d39d04 (
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
|
<?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>
|
