<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
<MAN>
  <LANGUAGE>eng</LANGUAGE>
  <TITLE>speye</TITLE>
  <TYPE>Scilab Function</TYPE>
  <DATE>January 1995</DATE>
  <SHORT_DESCRIPTION name="speye">  sparse identity matrix</SHORT_DESCRIPTION>
  <CALLING_SEQUENCE>
    <CALLING_SEQUENCE_ITEM>Isp=speye(nrows,ncols)  </CALLING_SEQUENCE_ITEM>
    <CALLING_SEQUENCE_ITEM>Isp=speye(A)  </CALLING_SEQUENCE_ITEM>
  </CALLING_SEQUENCE>
  <PARAM>
    <PARAM_INDENT>
      <PARAM_ITEM>
        <PARAM_NAME>nrows</PARAM_NAME>
        <PARAM_DESCRIPTION>
          <SP>: integer (number of rows)</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
      <PARAM_ITEM>
        <PARAM_NAME>ncols</PARAM_NAME>
        <PARAM_DESCRIPTION>
          <SP>: integer (number os columns)</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
      <PARAM_ITEM>
        <PARAM_NAME>A</PARAM_NAME>
        <PARAM_DESCRIPTION>
          <SP>: sparse matrix</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
      <PARAM_ITEM>
        <PARAM_NAME>sp</PARAM_NAME>
        <PARAM_DESCRIPTION>
          <SP>: sparse identity matrix</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
    </PARAM_INDENT>
  </PARAM>
  <DESCRIPTION>
    <P><VERB>Isp=speye(nrows,ncols)</VERB> returns a sparse identity matrix <VERB>Isp</VERB> 
    with <VERB>nrows</VERB> rows, <VERB>ncols</VERB> columns. (Non square identity matrix
    have a maximal number of ones along the main diagonal).</P>
    <P><VERB>Isp=speye(A)</VERB> returns a sparse identity matrix with same
    dimensions as <VERB>A</VERB>. If <VERB>[m,n]=size(A)</VERB>, <VERB>speye(m,n)</VERB> and
    <VERB>speye(A)</VERB> are equivalent. In particular <VERB>speye(3)</VERB> is not
    equivalent to <VERB>speye(3,3)</VERB>.</P>
  </DESCRIPTION>
  <EXAMPLE>
<![CDATA[
eye(3,3)-full(speye(3,3))
 ]]>
  </EXAMPLE>
  <SEE_ALSO>
    <SEE_ALSO_ITEM>
      <LINK>sparse</LINK>
    </SEE_ALSO_ITEM>
    <SEE_ALSO_ITEM>
      <LINK>full</LINK>
    </SEE_ALSO_ITEM>
    <SEE_ALSO_ITEM>
      <LINK>eye</LINK>
    </SEE_ALSO_ITEM>
    <SEE_ALSO_ITEM>
      <LINK>spzeros</LINK>
    </SEE_ALSO_ITEM>
    <SEE_ALSO_ITEM>
      <LINK>spones</LINK>
    </SEE_ALSO_ITEM>
  </SEE_ALSO>
</MAN>
