Chooses machine-dependent parameters for the local environment. -More...
-#include "slu_sdefs.h"+
#include "slu_Cnames.h"
Functions | |
| int | sp_ienv (int ispec) |
| sp_ienv() is inquired to choose machine-dependent parameters for the local environment. More... | |
Function Documentation
+Detailed Description
+Copyright (c) 2003, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from U.S. Dept. of Energy)
+All rights reserved.
+The source code is distributed under BSD license, see the file License.txt at the top-level directory.
+Function Documentation
◆ sp_ienv()
@@ -96,28 +84,48 @@
-See ISPEC for a description of the parameters. This version provides a set of parameters which should give good, but not optimal, performance on many of the currently available computers. Users are encouraged to modify this subroutine to set the tuning parameters for their particular machine using the option and problem size information in the arguments.
-- Parameters
-
-
- [in] ispec Specifies the parameter to be returned as the value of SP_IENV.
- = 1: the panel size w; a panel consists of w consecutive columns of matrix A in the process of Gaussian elimination. The best value depends on machine's cache characters.
- = 2: the relaxation parameter relax; if the number of nodes (columns) in a subtree of the elimination tree is less than relax, this subtree is considered as one supernode, regardless of their row structures.
- = 3: the maximum size for a supernode in complete LU.
- = 4: the minimum row dimension for 2-D blocking to be used.
- = 5: the minimum column dimension for 2-D blocking to be used.
- = 6: the estimated fills factor for L and U, compared with A.
- = 7: the maximum size for a supernode in ILU.
-
-
-- Returns
- >= 0: the value of the parameter specified by ispec.
- < 0: if SP_IENV = -k, the k-th argument had an illegal value.
-
+
+ Purpose
+ =======
+
+ sp_ienv() is inquired to choose machine-dependent parameters for the
+ local environment. See ISPEC for a description of the parameters.
+
+ This version provides a set of parameters which should give good,
+ but not optimal, performance on many of the currently available
+ computers. Users are encouraged to modify this subroutine to set
+ the tuning parameters for their particular machine using the option
+ and problem size information in the arguments.
+
+ Arguments
+ =========
+
+ ISPEC (input) int
+ Specifies the parameter to be returned as the value of SP_IENV.
+ = 1: the panel size w; a panel consists of w consecutive
+ columns of matrix A in the process of Gaussian elimination.
+ The best value depends on machine's cache characters.
+ = 2: the relaxation parameter relax; if the number of
+ nodes (columns) in a subtree of the elimination tree is less
+ than relax, this subtree is considered as one supernode,
+ regardless of their row structures.
+ = 3: the maximum size for a supernode in complete LU;
+ = 4: the minimum row dimension for 2-D blocking to be used;
+ = 5: the minimum column dimension for 2-D blocking to be used;
+ = 6: the estimated fills factor for L and U, compared with A;
+ = 7: the maximum size for a supernode in ILU.
+
+ (SP_IENV) (output) int
+ >= 0: the value of the parameter specified by ISPEC
+ < 0: if SP_IENV = -k, the k-th argument had an illegal value.
+
+ =====================================================================
+
Here is the call graph for this function:
diff --git a/DOC/html/SRC_2sp__ienv_8c.html b/DOC/html/SRC_2sp__ienv_8c.html
index 339fad1d..d7f1ae45 100644
--- a/DOC/html/SRC_2sp__ienv_8c.html
+++ b/DOC/html/SRC_2sp__ienv_8c.html
@@ -45,7 +45,7 @@
@@ -68,10 +68,7 @@
Detailed Description
-Copyright (c) 2003, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from U.S. Dept. of Energy)
-All rights reserved.
-The source code is distributed under BSD license, see the file License.txt at the top-level directory.
-
+
-- SuperLU routine (version 4.1) --
Univ. of California Berkeley, Xerox Palo Alto Research Center,
and Lawrence Berkeley National Lab.
diff --git a/DOC/html/annotated.html b/DOC/html/annotated.html
index 2f379306..59778d62 100644
--- a/DOC/html/annotated.html
+++ b/DOC/html/annotated.html
@@ -46,21 +46,21 @@
| [in] | ispec | Specifies the parameter to be returned as the value of SP_IENV. - = 1: the panel size w; a panel consists of w consecutive columns of matrix A in the process of Gaussian elimination. The best value depends on machine's cache characters. - = 2: the relaxation parameter relax; if the number of nodes (columns) in a subtree of the elimination tree is less than relax, this subtree is considered as one supernode, regardless of their row structures. - = 3: the maximum size for a supernode in complete LU. - = 4: the minimum row dimension for 2-D blocking to be used. - = 5: the minimum column dimension for 2-D blocking to be used. - = 6: the estimated fills factor for L and U, compared with A. - = 7: the maximum size for a supernode in ILU. |
- < 0: if SP_IENV = -k, the k-th argument had an illegal value.
+ Purpose + ======= + + sp_ienv() is inquired to choose machine-dependent parameters for the + local environment. See ISPEC for a description of the parameters. + + This version provides a set of parameters which should give good, + but not optimal, performance on many of the currently available + computers. Users are encouraged to modify this subroutine to set + the tuning parameters for their particular machine using the option + and problem size information in the arguments. + + Arguments + ========= + + ISPEC (input) int + Specifies the parameter to be returned as the value of SP_IENV. + = 1: the panel size w; a panel consists of w consecutive + columns of matrix A in the process of Gaussian elimination. + The best value depends on machine's cache characters. + = 2: the relaxation parameter relax; if the number of + nodes (columns) in a subtree of the elimination tree is less + than relax, this subtree is considered as one supernode, + regardless of their row structures. + = 3: the maximum size for a supernode in complete LU; + = 4: the minimum row dimension for 2-D blocking to be used; + = 5: the minimum column dimension for 2-D blocking to be used; + = 6: the estimated fills factor for L and U, compared with A; + = 7: the maximum size for a supernode in ILU. + + (SP_IENV) (output) int + >= 0: the value of the parameter specified by ISPEC + < 0: if SP_IENV = -k, the k-th argument had an illegal value. + + ===================================================================== +
Detailed Description
-Copyright (c) 2003, The Regents of the University of California, through Lawrence Berkeley National Laboratory (subject to receipt of any required approvals from U.S. Dept. of Energy)
-All rights reserved.
-The source code is distributed under BSD license, see the file License.txt at the top-level directory.
-+-- SuperLU routine (version 4.1) -- Univ. of California Berkeley, Xerox Palo Alto Research Center, and Lawrence Berkeley National Lab. diff --git a/DOC/html/annotated.html b/DOC/html/annotated.html index 2f379306..59778d62 100644 --- a/DOC/html/annotated.html +++ b/DOC/html/annotated.html @@ -46,21 +46,21 @@
diff --git a/DOC/html/cfgmr_8c.html b/DOC/html/cfgmr_8c.html
index 8a8940f7..42bb99e9 100644
--- a/DOC/html/cfgmr_8c.html
+++ b/DOC/html/cfgmr_8c.html
@@ -62,17 +62,17 @@
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
+
+
+
diff --git a/DOC/html/cgsequ_8c.html b/DOC/html/cgsequ_8c.html
index 9072b184..4db49e67 100644
--- a/DOC/html/cgsequ_8c.html
+++ b/DOC/html/cgsequ_8c.html
@@ -58,21 +58,21 @@
diff --git a/DOC/html/cgsisx_8c.html b/DOC/html/cgsisx_8c.html
index 523b199d..f155a1d8 100644
--- a/DOC/html/cgsisx_8c.html
+++ b/DOC/html/cgsisx_8c.html
@@ -61,23 +61,23 @@
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
+
+
+
diff --git a/DOC/html/cgsitrf_8c.html b/DOC/html/cgsitrf_8c.html
index ba1bc1be..0b15d3d7 100644
--- a/DOC/html/cgsitrf_8c.html
+++ b/DOC/html/cgsitrf_8c.html
@@ -61,23 +61,23 @@
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
+
+
+
diff --git a/DOC/html/cgsrfs_8c.html b/DOC/html/cgsrfs_8c.html
index 42b306a9..17b97742 100644
--- a/DOC/html/cgsrfs_8c.html
+++ b/DOC/html/cgsrfs_8c.html
@@ -59,21 +59,21 @@
diff --git a/DOC/html/cgssv_8c.html b/DOC/html/cgssv_8c.html
index 6cf1e4c1..7dbb64b0 100644
--- a/DOC/html/cgssv_8c.html
+++ b/DOC/html/cgssv_8c.html
@@ -61,23 +61,23 @@
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
+
+
+
diff --git a/DOC/html/cgssvx_8c.html b/DOC/html/cgssvx_8c.html
index 5498ba7f..db927337 100644
--- a/DOC/html/cgssvx_8c.html
+++ b/DOC/html/cgssvx_8c.html
@@ -61,23 +61,23 @@
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
+
+
+
diff --git a/DOC/html/citersol_8c.html b/DOC/html/citersol_8c.html
index e22b484d..b2aca0a4 100644
--- a/DOC/html/citersol_8c.html
+++ b/DOC/html/citersol_8c.html
@@ -62,28 +62,28 @@
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-
-
-
+
+
+
diff --git a/DOC/html/clangs_8c.html b/DOC/html/clangs_8c.html
index c3bec099..961b6a61 100644
--- a/DOC/html/clangs_8c.html
+++ b/DOC/html/clangs_8c.html
@@ -58,21 +58,21 @@
diff --git a/DOC/html/claqgs_8c.html b/DOC/html/claqgs_8c.html
index d353ea39..ac8786b1 100644
--- a/DOC/html/claqgs_8c.html
+++ b/DOC/html/claqgs_8c.html
@@ -59,21 +59,21 @@
