{
  "__type": "IngestedDoc",
  "__tag": 4010,
  "_content": {
    "Notes": {
      "__type": "Section",
      "__tag": 4015,
      "children": [],
      "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": [
        {
          "__type": "Parameters",
          "__tag": 4026,
          "children": [
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "res",
              "annotation": "tuple ``(lmin, lmax)``",
              "desc": []
            }
          ]
        }
      ],
      "title": [],
      "level": 0,
      "target": null
    },
    "Summary": {
      "__type": "Section",
      "__tag": 4015,
      "children": [
        {
          "__type": "Paragraph",
          "__tag": 4045,
          "children": [
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "Given a parameter vector "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "x0"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " with length "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "n"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " and a direction vector "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "alpha"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " with length "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "n"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": ", and lower and upper bounds on each of the "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "n"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " parameters, what are the bounds on a scalar "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "l"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": " such that "
            },
            {
              "__type": "InlineCode",
              "__tag": 4051,
              "value": "lower_bound <= x0 + alpha * l <= upper_bound"
            },
            {
              "__type": "Text",
              "__tag": 4046,
              "value": "."
            }
          ]
        }
      ],
      "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": "x0",
              "annotation": "np.array.",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "The vector representing the current location. Note "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "np.shape(x0) == (n,)"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "alpha",
              "annotation": "np.array.",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "The vector representing the direction. Note "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "np.shape(alpha) == (n,)"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "lower_bound",
              "annotation": "np.array.",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "The lower bounds for each parameter in "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "x0"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ". If the "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "i``th parameter in ``x0"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " is unbounded below, then "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "lower_bound[i]"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " should be "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "-np.inf"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ". Note "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "np.shape(lower_bound) == (n,)"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "."
                    }
                  ]
                }
              ]
            },
            {
              "__type": "DocParam",
              "__tag": 4016,
              "name": "upper_bound",
              "annotation": "np.array.",
              "desc": [
                {
                  "__type": "Paragraph",
                  "__tag": 4045,
                  "children": [
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "The upper bounds for each parameter in "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "x0"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ". If the "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "i``th parameter in ``x0"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " is unbounded above, then "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "upper_bound[i]"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": " should be "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "np.inf"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": ". Note "
                    },
                    {
                      "__type": "InlineCode",
                      "__tag": 4051,
                      "value": "np.shape(upper_bound) == (n,)"
                    },
                    {
                      "__type": "Text",
                      "__tag": 4046,
                      "value": "."
                    }
                  ]
                }
              ]
            }
          ]
        }
      ],
      "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/optimize/_optimize.py",
  "item_line": 3151,
  "item_type": "function",
  "aliases": [
    "scipy.optimize._optimize._line_for_search"
  ],
  "example_section_data": {
    "__type": "Section",
    "__tag": 4015,
    "children": [],
    "title": [],
    "level": 0,
    "target": null
  },
  "see_also": [],
  "signature": {
    "__type": "SignatureNode",
    "__tag": 4029,
    "kind": "function",
    "parameters": [
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "x0",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "alpha",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "lower_bound",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      },
      {
        "__type": "SigParam",
        "__tag": 4030,
        "name": "upper_bound",
        "annotation": {
          "__type": "Empty",
          "__tag": 4031
        },
        "kind": "POSITIONAL_OR_KEYWORD",
        "default": {
          "__type": "Empty",
          "__tag": 4031
        }
      }
    ],
    "return_annotation": {
      "__type": "Empty",
      "__tag": 4031
    },
    "target_name": "_line_for_search"
  },
  "references": null,
  "qa": "scipy.optimize._optimize:_line_for_search",
  "arbitrary": [],
  "local_refs": [
    "alpha",
    "lower_bound",
    "res",
    "upper_bound",
    "x0"
  ]
}