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

« back to all changes in this revision

Viewing changes to man/eng/mtlb/mtlb_tril.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
<!-- When this file is modified please also modify mtlb_triu.xml -->
 
3
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
4
<MAN>
 
5
  <LANGUAGE>eng</LANGUAGE>
 
6
  <TITLE>mtlb_tril</TITLE>
 
7
  <TYPE>M2SCI function</TYPE>
 
8
  <DATE>April 2004</DATE>
 
9
 
 
10
  <SHORT_DESCRIPTION name="mtlb_tril">Matlab tril emulation function</SHORT_DESCRIPTION>
 
11
 
 
12
  <DESCRIPTION>
 
13
 
 
14
    <P>Matlab and Scilab <VERB>tril</VERB> behave differently in some particular cases:</P>
 
15
 
 
16
    <DESCRIPTION_INDENT>
 
17
    <DESCRIPTION_ITEM>
 
18
    <ITEMIZE>
 
19
      <ITEM>
 
20
        <SP>
 
21
        With complex input: Matlab <VERB>tril</VERB> can be used with complex data but not Scilab one.
 
22
        </SP>
 
23
      </ITEM>
 
24
 
 
25
      <ITEM>
 
26
        <SP>
 
27
        With character strings inputs: due to the fact the Matlab and Scilab do not consider character
 
28
        strings in the same way, Scilab and Matlab <VERB>tril</VERB> do not give the same results
 
29
        for this type of input.
 
30
        </SP>
 
31
      </ITEM>
 
32
 
 
33
      <ITEM>
 
34
        <SP>
 
35
        With boolean inputs: Matlab <VERB>tril</VERB> can be used with boobean data but not Scilab one.
 
36
        </SP>
 
37
      </ITEM>
 
38
    </ITEMIZE>
 
39
    </DESCRIPTION_ITEM>
 
40
    </DESCRIPTION_INDENT>
 
41
 
 
42
    <P>
 
43
    The function <VERB>mtlb_tril(x,k)</VERB> is used by
 
44
    <VERB>mfile2sci</VERB> to replace <VERB>tril(x,k)</VERB> when it was not
 
45
    possible to know what were the inputs while porting Matlab code to Scilab. This function will
 
46
    determine the correct semantic at run time. If you want to have a
 
47
    more efficient code it is possible to replace <VERB>mtlb_tril</VERB> calls:
 
48
    </P>
 
49
 
 
50
    <DESCRIPTION_INDENT>
 
51
    <DESCRIPTION_ITEM>
 
52
    <ITEMIZE>
 
53
      <ITEM>
 
54
        <SP>
 
55
        If <VERB>X</VERB> contains real double values
 
56
        <VERB>mtlb_tril(x,k)</VERB> may be replaced by <VERB>tril(x,k)</VERB>
 
57
        </SP>
 
58
      </ITEM>
 
59
 
 
60
      <ITEM>
 
61
        <SP>
 
62
        If <VERB>X</VERB> contains boolean values
 
63
        <VERB>mtlb_tril(x,k)</VERB> may be replaced by <VERB>tril(bool2s(x),k)</VERB>
 
64
        </SP>
 
65
      </ITEM>
 
66
    </ITEMIZE>
 
67
    </DESCRIPTION_ITEM>
 
68
    </DESCRIPTION_INDENT>
 
69
 
 
70
    <P>Caution: <VERB>mtlb_tril</VERB> has not to be used for hand coded functions.</P>
 
71
 
 
72
  </DESCRIPTION>
 
73
 
 
74
  <SEE_ALSO>
 
75
    <SEE_ALSO_ITEM> <LINK>Matlab-Scilab_character_strings</LINK> </SEE_ALSO_ITEM>
 
76
  </SEE_ALSO>
 
77
 
 
78
  <AUTHORS>
 
79
    <AUTHORS_ITEM>V.C.</AUTHORS_ITEM>
 
80
  </AUTHORS>
 
81
</MAN>