| <!-- Copyright (c) 2010-2026 Arm Limited or its affiliates. All rights reserved. --> |
| <!-- This document is Non-confidential and licensed under the BSD 3-clause license. --> |
| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="x-ua-compatible" content="ie=edge"> |
| |
| <!--FAVICON.ico--> |
| <meta name="msapplication-TileColor" content="#2b5797"> |
| <meta name="msapplication-TileImage" content="../img/mstile-144x144.png"> |
| <link rel="icon" href="../img/favicon.ico"> |
| |
| <title>Traits.HasIndexes - ARM Machine Readable Schema - 2.8</title> |
| |
| <!--CSS--> |
| <link rel="stylesheet" type="text/css" href="../css/bootstrap.min.css"> |
| <link rel="stylesheet" type="text/css" href="../css/schema.css"> |
| <link rel="stylesheet" type="text/css" href="../css/hljs-github.css"> |
| </head> |
| <body> |
| <div class="container"> |
| <div class="row heading"> |
| <div class="col-md-6 pull-left"><a href="../index.html"><img src="../img/arm.svg" class="logo" /></a></div> |
| <div class="col-md-6 pull-left"><h1>AARCHMRS Schema <small>2.8</small></h1></div> |
| |
| <!--Show the home button--> |
| <a href="../index.html"><div class="back-to-home">↚ Home</div></a> |
| </div> |
| </div> |
| |
| <div class="container"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div class="row"> |
| |
| |
| |
| |
| <h2> |
| <span class="title-namespace">Traits.</span><span class=" title-type">HasIndexes</span> |
| |
| <!-- if oneOf is set, then type is ignored --> |
| <span class="type">object</span> |
| </h2> |
| |
| |
| |
| |
| <div class="static-markdown"><p><code>HasIndexes</code> provides an abstract definition for schemata that provide an array-like definition of an object.</p></div> |
| </div> |
| |
| <!-- definitions --> |
| <div class="row"> |
| <h3><span class="type Xof">definition</span></h3> |
| <table class="table table-hover definitions"> |
| <thead> |
| <tr> |
| <th class="col-md-4">Definitions</th> |
| <th class="col-md-4">Type</th> |
| <th class="col-md-4">Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| |
| |
| <tr id="/definitions/index_variable" class="property"> |
| <th class="col-md-4"> |
| <a href="#/definitions/index_variable">index_variable</a> |
| </th> |
| <td class="col-md-4"> |
| <ul class="inline list-type"> |
| <li class="inline type">string</li> |
| </ul> |
| </td> |
| <td class="col-md-4"> |
| <div><p>The variable that must be present in the models access in the form <code><index_variable></code> to be replaced with an index defined in the indexes property.</p> |
| <p><code>x</code> by default.</p></div> |
| <dl> |
| <dt>Pattern</dt> |
| <dd><code title="Regex">/[A-Za-z][A-Za-z0-9_]*/</code></dd> |
| </dl> |
| |
| |
| |
| </td> |
| </tr> |
| |
| <tr id="/definitions/indexes" class="property"> |
| <th class="col-md-4"> |
| <a href="#/definitions/indexes">indexes</a> |
| </th> |
| <td class="col-md-4"> |
| <a href="../Rangeset_schema.html" class="schema_link">Rangeset</a> |
| </td> |
| <td class="col-md-4"> |
| <div><p>The range of values that the containing model can expand to, in order.</p></div> |
| |
| <div> |
| See |
| <a href="../Rangeset_schema.html" class="schema_link">Rangeset</a> |
| for more information. |
| </div> |
| |
| |
| |
| |
| </td> |
| </tr> |
| |
| </tbody> |
| </table> |
| </div> |
| |
| |
| |
| |
| |
| <div class="row"> |
| |
| <div> |
| <!-- A simple object --> |
| |
| |
| <!-- array, and it has described items --> |
| </div> |
| |
| |
| <h5>Examples</h5> |
| <div> |
| <pre class="schema-json"><code class="language-json">{ |
| "indexes": "3:0", |
| "index_variable": "n" |
| }</code></pre> |
| </div> |
| |
| |
| |
| |
| </div> |
| |
| <div class="row schema"> |
| <h3>Schema <small><a href="http://json-schema.org/draft-04/schema#">http://json-schema.org/draft-04/schema#</a></small></h3> |
| <pre class="schema-json"><code class="language-json">{ |
| "title": "Traits.HasIndexes", |
| "info": [ |
| "`HasIndexes` provides an abstract definition for schemata that provide an array-like definition of an object." |
| ], |
| "definitions": { |
| "indexes": { |
| "$ref": "../Rangeset.json", |
| "info": [ |
| "The range of values that the containing model can expand to, in order." |
| ] |
| }, |
| "index_variable": { |
| "info": [ |
| "The variable that must be present in the models access in the form `<index_variable>` to be replaced with an index defined in the indexes property.", |
| "`x` by default." |
| ], |
| "type": "string", |
| "pattern": "[A-Za-z][A-Za-z0-9_]*" |
| } |
| }, |
| "examples": [ |
| { |
| "indexes": "3:0", |
| "index_variable": "n" |
| } |
| ], |
| "$schema": "http://json-schema.org/draft-04/schema#", |
| "type": "object" |
| }</code></pre> |
| </div> |
| |
| </div> |
| |
| <div class="container"> |
| <div class="footer text-right"> |
| Copyright © 2025 ARM Limited or its affiliates. All rights reserved. |
| </div> |
| </div> |
| |
| <script src="../js/highlight/highlight.js"></script> |
| <script src="../js/highlight/languages/json.min.js"></script> |
| <script src="../js/highlight/languages/django.min.js"></script> <!-- JINJA2 --> |
| <script src="../js/highlight/languages/yaml.min.js"></script> |
| <script src="../js/highlight/languages/isa.js"></script> |
| <script type="text/javascript"> |
| window.onload = function() { |
| hljs.configure({ |
| cssSelector: ".schema-json code, .includes code, pre code", |
| noHighlightRe: /^(no-?highlight|nohl)$/i, |
| }); |
| hljs.highlightAll() |
| }; |
| </script> |
| |
| </body> |
| </html> |
