Index of Functions: A  B  C  D  E  F  G  H  I  J  K  L  M  N  O  P  Q  R  S  T  U  V  W  X 
Index Page
cspice_mequ

Table of contents
Abstract
I/O
Parameters
Examples
Particulars
Exceptions
Files
Restrictions
Required_Reading
Literature_References
Author_and_Institution
Version
Index_Entries


Abstract


   CSPICE_MEQU sets one double precision 3x3 matrix equal to another.

I/O


   Given:

      m1       an arbitrary input 3x3 matrix.

               help, m1
                  DOUBLE = Array[3,3]

               There are no restrictions on what it may contain.

   the call:

      cspice_mequ, m1, mout

   returns:

      mout     a 3x3 matrix set to be equal to `m1'.

               help, mout
                  DOUBLE = Array[3,3]

Parameters


   None.

Examples


   Any numerical results shown for this example may differ between
   platforms as the results depend on the SPICE kernels used as input
   and the machine specific arithmetic implementation.

   1) This trivial example demonstrates how to use cspice_mequ to assign
      one matrix to another.


      Example code begins here.


      PRO mequ_ex1

         ;;
         ;; Define `m1'.
         ;;
         m1 = [ [ 0.D0, -1.D0,  0.D0 ],                                      $
                [ 1.D0,  0.D0,  0.D0 ],                                      $
                [ 0.D0,  0.D0,  1.D0 ] ]

         ;;
         ;; Assign `m1' to `mout' and print `mout'.
         ;;
         cspice_mequ, m1, mout

         print, format='(A)', 'MOUT:'
         print, format='(3F16.7)', mout

      END


      When this program was executed on a Mac/Intel/IDL8.x/64-bit
      platform, the output was:


      MOUT:
             0.0000000      -1.0000000       0.0000000
             1.0000000       0.0000000       0.0000000
             0.0000000       0.0000000       1.0000000


Particulars


   IDL native code to accomplish the same operation:

      mout = m1

   The IDL '=' operator functions on arbitrary MxN matrices.

Exceptions


   1)  If the input argument `m1' is undefined, an error is signaled
       by the IDL error handling system.

   2)  If the input argument `m1' is not of the expected type, or it
       does not have the expected dimensions and size, an error is
       signaled by the Icy interface.

   3)  If the output argument `mout' is not a named variable, an
       error is signaled by the Icy interface.

Files


   None.

Restrictions


   None.

Required_Reading


   ICY.REQ

Literature_References


   None.

Author_and_Institution


   J. Diaz del Rio     (ODC Space)
   E.D. Wright         (JPL)

Version


   -Icy Version 1.0.2, 10-AUG-2021 (JDR)

       Edited the header to comply with NAIF standard. Added complete
       code example.

       Added -Parameters, -Exceptions, -Files, -Restrictions,
       -Literature_References and -Author_and_Institution sections.

       Removed reference to the routine's corresponding CSPICE header from
       -Abstract section.

       Added arguments' type and size information in the -I/O section.

   -Icy Version 1.0.1, 09-DEC-2005 (EDW)

       Added -Examples section.

   -Icy Version 1.0.0, 16-JUN-2003 (EDW)

Index_Entries


   equal to another 3x3_matrix



Fri Dec 31 18:43:06 2021