{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array API Standard Support" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "maxdists", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "maxdists" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " has experimental support for Python Array API Standard compatible backends in addition to NumPy. Please consider testing these features by setting an environment variable " }, { "__type": "InlineCode", "__tag": 4051, "value": "SCIPY_ARRAY_API=1" }, { "__type": "Text", "__tag": 4046, "value": " and providing CuPy, PyTorch, JAX, or Dask arrays as array arguments. The following combinations of backend and device (or other capability) are supported." } ] }, { "__type": "Code", "__tag": 4050, "value": "==================== ==================== ====================\nLibrary CPU GPU\n==================== ==================== ====================\nNumPy ✅ n/a \nCuPy n/a ⛔ \nPyTorch ✅ ⛔ \nJAX ✅ ⛔ \nDask ⚠️ merges chunks n/a \n==================== ==================== ====================", "execution_status": null }, { "__type": "Blockquote", "__tag": 4059, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "See " }, { "__type": "InlineRole", "__tag": 4003, "value": "dev-arrayapi", "domain": null, "role": "ref", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for more information." } ] } ] } ], "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": "maxdists", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A " }, { "__type": "InlineCode", "__tag": 4051, "value": "(n-1)" }, { "__type": "Text", "__tag": 4046, "value": " sized numpy array of doubles; " }, { "__type": "InlineCode", "__tag": 4051, "value": "MD[i]" }, { "__type": "Text", "__tag": 4046, "value": " represents the maximum distance between any cluster (including singletons) below and including the node with index i. More specifically, " }, { "__type": "InlineCode", "__tag": 4051, "value": "MD[i] = Z[Q(i)-n, 2].max()" }, { "__type": "Text", "__tag": 4046, "value": " where " }, { "__type": "InlineCode", "__tag": 4051, "value": "Q(i)" }, { "__type": "Text", "__tag": 4046, "value": " is the set of all node indices below and including node i." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return the maximum distance between any non-singleton cluster." } ] } ], "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": "Z", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The hierarchical clustering encoded as a matrix. See " }, { "__type": "InlineCode", "__tag": 4051, "value": "linkage" }, { "__type": "Text", "__tag": 4046, "value": " for more information." } ] } ] } ] } ], "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/cluster/hierarchy.py", "item_line": 3903, "item_type": "function", "aliases": [ "scipy.cluster.hierarchy.maxdists" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from scipy.cluster.hierarchy import median, maxdists\nfrom scipy.spatial.distance import pdist\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nGiven a linkage matrix ``Z``, `scipy.cluster.hierarchy.maxdists`\ncomputes for each new cluster generated (i.e., for each row of the linkage\nmatrix) what is the maximum distance between any two child clusters.\n\nDue to the nature of hierarchical clustering, in many cases this is going\nto be just the distance between the two child clusters that were merged\nto form the current one - that is, Z[:,2].\n\nHowever, for non-monotonic cluster assignments such as\n`scipy.cluster.hierarchy.median` clustering this is not always the\ncase: There may be cluster formations were the distance between the two\nclusters merged is smaller than the distance between their children.\n\nWe can see this in an example:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "X = [[0, 0], [0, 1], [1, 0],\n [0, 4], [0, 3], [1, 4],\n [4, 0], [3, 0], [4, 1],\n [4, 4], [3, 4], [4, 3]]\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "Z = median(pdist(X))\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "Z\nmaxdists(Z)\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nNote that while the distance between the two clusters merged when creating the\nlast cluster is 3.25, there are two children (clusters 16 and 17) whose distance\nis larger (3.5). Thus, `scipy.cluster.hierarchy.maxdists` returns 3.5 in\nthis case." } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "is_monotonic", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.cluster.hierarchy:is_monotonic" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "for testing for monotonicity of a linkage matrix." } ] } ], "type": "func" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "linkage", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "linkage" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "for a description of what a linkage matrix is." } ] } ], "type": "func" } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "Z", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "maxdists" }, "references": null, "qa": "scipy.cluster.hierarchy:maxdists", "arbitrary": [], "local_refs": [ "Z", "maxdists" ] }