umfpack_tictoc.h

Go to the documentation of this file.
00001 /* ========================================================================== */
00002 /* === umfpack_tictoc ======================================================= */
00003 /* ========================================================================== */
00004 
00005 /* -------------------------------------------------------------------------- */
00006 /* UMFPACK Version 4.3 (Jan. 16, 2004), Copyright (c) 2004 by Timothy A.      */
00007 /* Davis.  All Rights Reserved.  See ../README for License.                   */
00008 /* email: davis@cise.ufl.edu    CISE Department, Univ. of Florida.            */
00009 /* web: http://www.cise.ufl.edu/research/sparse/umfpack                       */
00010 /* -------------------------------------------------------------------------- */
00011 
00012 void umfpack_tic (double stats [2]) ;
00013 
00014 void umfpack_toc (double stats [2]) ;
00015 
00016 
00017 /*
00018 Syntax (for all versions: di, dl, zi, and zl):
00019 
00020     #include "umfpack.h"
00021     double stats [2] ;
00022     umfpack_tic (stats) ;
00023     ...
00024     umfpack_toc (stats) ;
00025 
00026 Purpose:
00027 
00028     umfpack_tic returns the CPU time and wall clock time used by the process.
00029     The CPU time includes both "user" and "system" time (the latter is time
00030     spent by the system on behalf of the process, and is thus charged to the
00031     process).  umfpack_toc returns the CPU time and wall clock time since the
00032     last call to umfpack_tic with the same stats array.
00033 
00034     Typical usage:
00035 
00036         umfpack_tic (stats) ;
00037         ... do some work ...
00038         umfpack_toc (stats) ;
00039 
00040     then stats [1] contains the time in seconds used by the code between
00041     umfpack_tic and umfpack_toc, and stats [0] contains the wall clock time
00042     elapsed between the umfpack_tic and umfpack_toc.  These two routines act
00043     just like tic and toc in MATLAB, except that the both process time and
00044     wall clock time are returned.
00045 
00046     This routine normally uses the sysconf and times routines in the POSIX
00047     standard.  If -DNPOSIX is defined at compile time, then the ANSI C clock
00048     routine is used instead, and only the CPU time is returned (stats [0]
00049     is set to zero).
00050 
00051     umfpack_tic and umfpack_toc are the routines used internally in UMFPACK
00052     to time the symbolic analysis, numerical factorization, and the forward/
00053     backward solve.
00054 
00055 Arguments:
00056 
00057     double stats [2]:
00058 
00059         stats [0]:  wall clock time, in seconds
00060         stats [1]:  CPU time, in seconds
00061 */

Generated on Sun May 27 11:59:43 2007 for FEMFLUID by  doxygen 1.4.6