rearrange.json

{
    "id": "rearrange",
    "summary": "Sort an array based on a permutation",
    "description": "Rearranges an array based on a ranked list of element positions in the original list (i.e., a permutation). The positions must be zero-based. The process ``order()`` can compute such a permutation.",
    "categories": [
        "arrays",
        "sorting"
    ],
    "parameters": [
        {
            "name": "data",
            "description": "The array to rearrange.",
            "schema": {
                "type": "array",
                "items": {
                    "description": "Any data type is allowed."
                }
            }
        },
        {
            "name": "order",
            "description": "The permutation used for rearranging.",
            "schema": {
                "type": "array",
                "items": {
                    "type": "integer",
                    "minimum": 0
                }
            }
        }
    ],
    "returns": {
        "description": "The rearranged array.",
        "schema": {
            "type": "array",
            "items": {
                "description": "Any data type is allowed."
            }
        }
    },
    "examples": [
        {
            "title": "Reverse a list",
            "arguments": {
                "data": [
                    5,
                    4,
                    3
                ],
                "order": [
                    2,
                    1,
                    0
                ]
            },
            "returns": [
                3,
                4,
                5
            ]
        },
        {
            "title": "Remove two elements",
            "arguments": {
                "data": [
                    5,
                    4,
                    3,
                    2
                ],
                "order": [
                    1,
                    3
                ]
            },
            "returns": [
                4,
                2
            ]
        },
        {
            "title": "Swap two elements",
            "arguments": {
                "data": [
                    5,
                    4,
                    3,
                    2
                ],
                "order": [
                    0,
                    2,
                    1,
                    3
                ]
            },
            "returns": [
                5,
                3,
                4,
                2
            ]
        }
    ],
    "links": [
        {
            "rel": "about",
            "href": "http://mathworld.wolfram.com/Permutation.html",
            "title": "Permutation explained by Wolfram MathWorld"
        }
    ]
}