{ "__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": "cophenet", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.cluster.hierarchy:cophenet" }, "kind": "module" }, { "__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": "c", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The cophentic correlation distance (if " }, { "__type": "InlineCode", "__tag": 4051, "value": "Y" }, { "__type": "Text", "__tag": 4046, "value": " is passed)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "d", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The cophenetic distance matrix in condensed form. The " }, { "__type": "InlineMath", "__tag": 4057, "value": "ij" }, { "__type": "Text", "__tag": 4046, "value": " th entry is the cophenetic distance between original observations " }, { "__type": "InlineMath", "__tag": 4057, "value": "i" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineMath", "__tag": 4057, "value": "j" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Calculate the cophenetic distances between each observation in the hierarchical clustering defined by the linkage " }, { "__type": "InlineCode", "__tag": 4051, "value": "Z" }, { "__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": "Z", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The hierarchical clustering encoded as an array (see " }, { "__type": "InlineRole", "__tag": 4003, "value": "linkage", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " function)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "Y", "annotation": "ndarray (optional)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Calculates the cophenetic correlation coefficient " }, { "__type": "InlineCode", "__tag": 4051, "value": "c" }, { "__type": "Text", "__tag": 4046, "value": " of a hierarchical clustering defined by the linkage matrix " }, { "__type": "ParamRef", "__tag": 4071, "name": "Z" }, { "__type": "Text", "__tag": 4046, "value": " of a set of " }, { "__type": "InlineMath", "__tag": 4057, "value": "n" }, { "__type": "Text", "__tag": 4046, "value": " observations in " }, { "__type": "InlineMath", "__tag": 4057, "value": "m" }, { "__type": "Text", "__tag": 4046, "value": " dimensions. " }, { "__type": "ParamRef", "__tag": 4071, "name": "Y" }, { "__type": "Text", "__tag": 4046, "value": " is the condensed distance matrix from which " }, { "__type": "ParamRef", "__tag": 4071, "name": "Z" }, { "__type": "Text", "__tag": 4046, "value": " was generated." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Suppose " }, { "__type": "InlineCode", "__tag": 4051, "value": "p" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "q" }, { "__type": "Text", "__tag": 4046, "value": " are original observations in disjoint clusters " }, { "__type": "InlineCode", "__tag": 4051, "value": "s" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "t" }, { "__type": "Text", "__tag": 4046, "value": ", respectively and " }, { "__type": "InlineCode", "__tag": 4051, "value": "s" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "t" }, { "__type": "Text", "__tag": 4046, "value": " are joined by a direct parent cluster " }, { "__type": "InlineCode", "__tag": 4051, "value": "u" }, { "__type": "Text", "__tag": 4046, "value": ". The cophenetic distance between observations " }, { "__type": "InlineCode", "__tag": 4051, "value": "i" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "j" }, { "__type": "Text", "__tag": 4046, "value": " is simply the distance between clusters " }, { "__type": "InlineCode", "__tag": 4051, "value": "s" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "t" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "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": 1576, "item_type": "function", "aliases": [ "scipy.cluster.hierarchy.cophenet" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "from scipy.cluster.hierarchy import single, cophenet\nfrom scipy.spatial.distance import pdist, squareform\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nGiven a dataset ``X`` and a linkage matrix ``Z``, the cophenetic distance\nbetween two points of ``X`` is the distance between the largest two\ndistinct clusters that each of the points:\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``X`` corresponds to this dataset ::\n\n x x x x\n x x\n\n x x\n x x x x\n\n" }, { "__type": "Code", "__tag": 4050, "value": "Z = single(pdist(X))\nZ\ncophenet(Z)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nThe output of the `scipy.cluster.hierarchy.cophenet` method is\nrepresented in condensed form. We can use\n`scipy.spatial.distance.squareform` to see the output as a\nregular matrix (where each element ``ij`` denotes the cophenetic distance\nbetween each ``i``, ``j`` pair of points in ``X``):\n\n" }, { "__type": "Code", "__tag": 4050, "value": "squareform(cophenet(Z))\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nIn this example, the cophenetic distance between points on ``X`` that are\nvery close (i.e., in the same corner) is 1. For other pairs of points is 2,\nbecause the points will be located in clusters at different\ncorners - thus, the distance between these clusters will be larger." } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__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" }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "scipy.spatial.distance.squareform", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "scipy.spatial.distance:squareform" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "transforming condensed matrices into square ones." } ] } ], "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 } }, { "__type": "SigParam", "__tag": 4030, "name": "Y", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "cophenet" }, "references": null, "qa": "scipy.cluster.hierarchy:cophenet", "arbitrary": [], "local_refs": [ "Y", "Z", "c", "d" ] }