~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/eng/mtlb/mtlb_close.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>mtlb_close</TITLE>
 
6
  <TYPE>M2SCI function</TYPE>
 
7
  <DATE>July 2004</DATE>
 
8
 
 
9
  <SHORT_DESCRIPTION name="mtlb_close">Matlab close emulation function</SHORT_DESCRIPTION>
 
10
 
 
11
  <DESCRIPTION>
 
12
 
 
13
    <P>Scilab equivalent for Matlab <VERB>close</VERB> is different according to the current figure type (uicontrol or graphic one).</P>
 
14
 
 
15
    <DESCRIPTION_INDENT>
 
16
    <DESCRIPTION_ITEM>
 
17
    <ITEMIZE>
 
18
      <ITEM>
 
19
        <SP>
 
20
        When current figure is a uicontrol one: Scilab equivalent for Matlab <VERB>close</VERB> is <VERB>close</VERB>
 
21
        </SP>
 
22
      </ITEM>
 
23
 
 
24
      <ITEM>
 
25
        <SP>
 
26
        When current figure is a graphic one: Scilab equivalent for Matlab <VERB>close</VERB>
 
27
        is <VERB>xdel</VERB> or <VERB>delete</VERB>
 
28
        </SP>
 
29
      </ITEM>
 
30
 
 
31
      <ITEM>
 
32
        <SP>
 
33
        In Scilab we do not get an error status.
 
34
        </SP>
 
35
      </ITEM>
 
36
    </ITEMIZE>
 
37
    </DESCRIPTION_ITEM>
 
38
    </DESCRIPTION_INDENT>
 
39
 
 
40
    <P>
 
41
    The function <VERB>mtlb_close([h])</VERB> is used by
 
42
    <VERB>mfile2sci</VERB> to replace <VERB>close([h])</VERB> when it was not
 
43
    possible to know what were the inputs while porting Matlab code to Scilab. This function will
 
44
    determine the correct semantic at run time. If you want to have a
 
45
    more efficient code it is possible to replace <VERB>mtlb_close</VERB> calls:
 
46
    </P>
 
47
 
 
48
    <DESCRIPTION_INDENT>
 
49
    <DESCRIPTION_ITEM>
 
50
    <ITEMIZE>
 
51
      <ITEM>
 
52
        <SP>
 
53
        If <VERB>h</VERB> is a uicontrol figure
 
54
        <VERB>mtlb_close(h)</VERB> may be replaced by <VERB>close(h)</VERB>
 
55
        </SP>
 
56
      </ITEM>
 
57
 
 
58
      <ITEM>
 
59
        <SP>
 
60
        If <VERB>h</VERB> is a graphic figure
 
61
        <VERB>mtlb_close(h)</VERB> may be replaced by <VERB>delete(h)</VERB>
 
62
        </SP>
 
63
      </ITEM>
 
64
    </ITEMIZE>
 
65
    </DESCRIPTION_ITEM>
 
66
    </DESCRIPTION_INDENT>
 
67
 
 
68
    <P>Caution: <VERB>mtlb_close</VERB> has not to be used for hand coded functions.</P>
 
69
 
 
70
  </DESCRIPTION>
 
71
 
 
72
  <SEE_ALSO>
 
73
    <SEE_ALSO_ITEM> <LINK>xdel</LINK> </SEE_ALSO_ITEM>
 
74
    <SEE_ALSO_ITEM> <LINK>delete</LINK> </SEE_ALSO_ITEM>
 
75
    <SEE_ALSO_ITEM> <LINK>winsid</LINK> </SEE_ALSO_ITEM>
 
76
    <SEE_ALSO_ITEM> <LINK>close</LINK> </SEE_ALSO_ITEM>
 
77
  </SEE_ALSO>
 
78
 
 
79
  <AUTHORS>
 
80
    <AUTHORS_ITEM>V.C.</AUTHORS_ITEM>
 
81
  </AUTHORS>
 
82
</MAN>