Blame view

fvn_sparse/UMFPACK/Include/umfpack_load_numeric.h 2.52 KB
422234dc3   daniau   git-svn-id: https...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
  /* ========================================================================== */
  /* === umfpack_load_numeric ================================================= */
  /* ========================================================================== */
  
  /* -------------------------------------------------------------------------- */
  /* UMFPACK Copyright (c) Timothy A. Davis, CISE,                              */
  /* Univ. of Florida.  All Rights Reserved.  See ../Doc/License for License.   */
  /* web: http://www.cise.ufl.edu/research/sparse/umfpack                       */
  /* -------------------------------------------------------------------------- */
  
  int umfpack_di_load_numeric
  (
      void **Numeric,
      char *filename
  ) ;
  
  UF_long umfpack_dl_load_numeric
  (
      void **Numeric,
      char *filename
  ) ;
  
  int umfpack_zi_load_numeric
  (
      void **Numeric,
      char *filename
  ) ;
  
  UF_long umfpack_zl_load_numeric
  (
      void **Numeric,
      char *filename
  ) ;
  
  /*
  double int Syntax:
  
      #include "umfpack.h"
      int status ;
      char *filename ;
      void *Numeric ;
      status = umfpack_di_load_numeric (&Numeric, filename) ;
  
  double UF_long Syntax:
  
      #include "umfpack.h"
      UF_long status ;
      char *filename ;
      void *Numeric ;
      status = umfpack_dl_load_numeric (&Numeric, filename) ;
  
  complex int Syntax:
  
      #include "umfpack.h"
      int status ;
      char *filename ;
      void *Numeric ;
      status = umfpack_zi_load_numeric (&Numeric, filename) ;
  
  complex UF_long Syntax:
  
      #include "umfpack.h"
      UF_long status ;
      char *filename ;
      void *Numeric ;
      status = umfpack_zl_load_numeric (&Numeric, filename) ;
  
  Purpose:
  
      Loads a Numeric object from a file created by umfpack_*_save_numeric.  The
      Numeric handle passed to this routine is overwritten with the new object.
      If that object exists prior to calling this routine, a memory leak will
      occur.  The contents of Numeric are ignored on input.
  
  Returns:
  
      UMFPACK_OK if successful.
      UMFPACK_ERROR_out_of_memory if not enough memory is available.
      UMFPACK_ERROR_file_IO if an I/O error occurred.
  
  Arguments:
  
      void **Numeric ;	    Output argument.
  
  	**Numeric is the address of a (void *) pointer variable in the user's
  	calling routine (see Syntax, above).  On input, the contents of this
  	variable are not defined.  On output, this variable holds a (void *)
  	pointer to the Numeric object (if successful), or (void *) NULL if
  	a failure occurred.
  
      char *filename ;	    Input argument, not modified.
  
  	A string that contains the filename from which to read the Numeric
  	object.
  */