{
  "__type": "IngestedDoc",
  "__tag": 4010,
  "_content": {
    "Notes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "The default sparse solver is UMFPACK when available ("
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "scikits.umfpack"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " is installed). This can be changed by passing useUmfpack = False, which then causes the always present SuperLU based solver to be used."
            }
          ]
        },
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "UMFPACK requires a CSR/CSC matrix to have sorted column/row indices. If sure that the matrix fulfills this, pass "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "assumeSortedIndices=True"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " to gain some speed."
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Warns": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Raises": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Yields": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Methods": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Returns": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Select default sparse direct solver to be used."
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Receives": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Warnings": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Attributes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Parameters": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Parameters",
          "__tag": 4026,
          "children": [
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "**kwargs",
              "annotation": "",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "The following options may be passed as keyword arguments."
                    }
                  ]
                },
                {
                  "__type": "DefList",
                  "__tag": 4033,
                  "children": [
                    {
                      "__type": "DefListItem",
                      "__tag": 4037,
                      "dt": {
                        "__type": "Paragraph",
                        "__tag": 4045,
                        "children": [
                          {
                            "__type": "Text",
                            "__tag": 4046,
                            "value": "useUmfpack"
                          }
                        ]
                      },
                      "dd": [
                        {
                          "__type": "Paragraph",
                          "__tag": 4045,
                          "children": [
                            {
                              "__type": "Text",
                              "__tag": 4046,
                              "value": "Use UMFPACK "
                            },
                            {
                              "__type": "FootnoteReference",
                              "__tag": 4066,
                              "label": "1"
                            },
                            {
                              "__type": "Text",
                              "__tag": 4046,
                              "value": ", "
                            },
                            {
                              "__type": "FootnoteReference",
                              "__tag": 4066,
                              "label": "2"
                            },
                            {
                              "__type": "Text",
                              "__tag": 4046,
                              "value": ", "
                            },
                            {
                              "__type": "FootnoteReference",
                              "__tag": 4066,
                              "label": "3"
                            },
                            {
                              "__type": "Text",
                              "__tag": 4046,
                              "value": ", "
                            },
                            {
                              "__type": "FootnoteReference",
                              "__tag": 4066,
                              "label": "4"
                            },
                            {
                              "__type": "Text",
                              "__tag": 4046,
                              "value": ". over SuperLU. Has effect only     if "
                            },
                            {
                              "__type": "InlineCode",
                              "__tag": 4051,
                              "value": "scikits.umfpack"
                            },
                            {
                              "__type": "Text",
                              "__tag": 4046,
                              "value": " is installed. Default: True"
                            }
                          ]
                        }
                      ]
                    },
                    {
                      "__type": "DefListItem",
                      "__tag": 4037,
                      "dt": {
                        "__type": "Paragraph",
                        "__tag": 4045,
                        "children": [
                          {
                            "__type": "Text",
                            "__tag": 4046,
                            "value": "assumeSortedIndices"
                          }
                        ]
                      },
                      "dd": [
                        {
                          "__type": "Paragraph",
                          "__tag": 4045,
                          "children": [
                            {
                              "__type": "Text",
                              "__tag": 4046,
                              "value": "Allow UMFPACK to skip the step of sorting indices for a CSR/CSC matrix.     Has effect only if useUmfpack is True and "
                            },
                            {
                              "__type": "InlineCode",
                              "__tag": 4051,
                              "value": "scikits.umfpack"
                            },
                            {
                              "__type": "Text",
                              "__tag": 4046,
                              "value": " is     installed. Default: False"
                            }
                          ]
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Extended Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    },
    "Other Parameters": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "title": [],
      "level": 0,
      "target": null
    }
  },
  "_ordered_sections": [
    "Summary",
    "Extended Summary",
    "Parameters",
    "Attributes",
    "Methods",
    "Returns",
    "Yields",
    "Receives",
    "Other Parameters",
    "Raises",
    "Warns",
    "Warnings",
    "Notes"
  ],
  "item_file": "/scipy/sparse/linalg/_dsolve/linsolve.py",
  "item_line": 33,
  "item_type": "function",
  "aliases": [
    "scipy.sparse.linalg.use_solver"
  ],
  "example_section_data": {
    "__type": "Section",
    "__tag": 4015,
    "children": [
      {
        "__type": "Code",
        "__tag": 4050,
        "value": "import numpy as np\nfrom scipy.sparse.linalg import use_solver, spsolve\nfrom scipy.sparse import csc_array\nR = np.random.randn(5, 5)\nA = csc_array(R)\nb = np.random.randn(5)\nuse_solver(useUmfpack=False) # enforce superLU over UMFPACK\nx = spsolve(A, b)\nnp.allclose(A.dot(x), b)\nuse_solver(useUmfpack=True) # reset umfPack usage to default\n",
        "execution_status": "success",
        "out": ""
      }
    ],
    "title": [],
    "level": 0,
    "target": null
  },
  "see_also": [],
  "signature": {
    "__type": "SignatureNode",
    "__tag": 4029,
    "kind": "function",
    "parameters": [
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "kwargs",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "VAR_KEYWORD",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      }
    ],
    "return_annotation": {
      "__type": "Empty",
      "__tag": 4031
    },
    "target_name": "use_solver"
  },
  "references": [
    ".. [1] T. A. Davis, Algorithm 832:  UMFPACK - an unsymmetric-pattern",
    "       multifrontal method with a column pre-ordering strategy, ACM",
    "       Trans. on Mathematical Software, 30(2), 2004, pp. 196--199.",
    "       :doi:`10.1145/992200.992206`.",
    "",
    ".. [2] T. A. Davis, A column pre-ordering strategy for the",
    "       unsymmetric-pattern multifrontal method, ACM Trans.",
    "       on Mathematical Software, 30(2), 2004, pp. 165--195.",
    "       :doi:`10.1145/992200.992205`.",
    "",
    ".. [3] T. A. Davis and I. S. Duff, A combined unifrontal/multifrontal",
    "       method for unsymmetric sparse matrices, ACM Trans. on",
    "       Mathematical Software, 25(1), 1999, pp. 1--19.",
    "       :doi:`10.1145/305658.287640`.",
    "",
    ".. [4] T. A. Davis and I. S. Duff, An unsymmetric-pattern multifrontal",
    "       method for sparse LU factorization, SIAM J. Matrix Analysis and",
    "       Computations, 18(1), 1997, pp. 140--158.",
    "       :doi:`10.1137/S0895479894246905T`."
  ],
  "qa": "scipy.sparse.linalg._dsolve.linsolve:use_solver",
  "arbitrary": [],
  "local_refs": [
    "**kwargs"
  ]
}