runmat-runtime 0.4.5

Core runtime for RunMat with builtins, BLAS/LAPACK integration, and execution APIs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

{
  "title": "figure",
  "category": "plotting",
  "keywords": [
    "figure",
    "plotting",
    "graphics handle",
    "window selection"
  ],
  "summary": "Create a new figure or select an existing figure handle.",
  "gpu_support": {
    "elementwise": false,
    "reduction": false,
    "precisions": [],
    "broadcasting": "none",
    "notes": "`figure` manages plotting state and handles. It does not execute numeric GPU kernels."
  },
  "fusion": {
    "elementwise": false,
    "reduction": false,
    "max_inputs": 1,
    "constants": "inline"
  },
  "requires_feature": null,
  "tested": {
    "integration": "runmat-plot/tests/renderer_tests.rs"
  },
  "description": "`figure` creates or selects the active plotting figure. With no arguments it allocates a fresh figure handle and makes that figure current. Passing a positive numeric handle selects that figure, creating it if it does not already exist. Passing `'next'` is equivalent to asking for a fresh figure.",
  "behaviors": [
    "`figure()` creates a new figure and returns its numeric handle.",
    "`figure(n)` selects figure `n`. If that handle does not exist yet, RunMat creates it.",
    "`figure('next')` creates a new figure instead of selecting an existing one.",
    "The selected figure becomes the target for subsequent plotting commands such as `plot`, `subplot`, `gca`, `clf`, and `hold`."
  ],
  "examples": [
    {
      "description": "Create a fresh figure",
      "input": "f = figure()",
      "output": "% f is a positive numeric figure handle"
    },
    {
      "description": "Create another figure with the explicit 'next' selector",
      "input": "f1 = figure();\nf2 = figure(\"next\")",
      "output": "% f2 is a different figure handle from f1"
    },
    {
      "description": "Select a specific figure handle",
      "input": "figure(3);\nplot(1:5, [1 4 2 5 3]);",
      "output": "% plotting now targets figure 3"
    }
  ],
  "faqs": [
    {
      "question": "Does `figure(n)` require the handle to exist already?",
      "answer": "No. RunMat selects figure `n`, creating it on demand if necessary."
    },
    {
      "question": "What does `figure('next')` do?",
      "answer": "It forces creation of a new figure rather than reusing an existing handle."
    },
    {
      "question": "Does `figure` draw anything by itself?",
      "answer": "No. It only manages the active figure selection. Plotting happens when you call builtins like `plot`, `scatter`, or `surf`."
    }
  ],
  "links": [
    {
      "label": "gcf",
      "url": "./gcf"
    },
    {
      "label": "gca",
      "url": "./gca"
    },
    {
      "label": "clf",
      "url": "./clf"
    },
    {
      "label": "subplot",
      "url": "./subplot"
    },
    {
      "label": "plot",
      "url": "./plot"
    },
    {
      "label": "Styling plots and axes",
      "url": "/docs/plotting/styling-plots-and-axes"
    },
    {
      "label": "Plot replay and export",
      "url": "/docs/plotting/plot-replay-and-export"
    },
    {
      "label": "Complete plotting guide",
      "url": "/blog/matlab-plotting-guide"
    }
  ],
  "source": {
    "label": "`crates/runmat-runtime/src/builtins/plotting/ops/figure.rs`",
    "url": "https://github.com/runmat-org/runmat/blob/main/crates/runmat-runtime/src/builtins/plotting/ops/figure.rs"
  },
  "gpu_residency": "`figure` only updates plotting state and returns a host-side numeric handle. It does not affect array residency.",
  "gpu_behavior": [
    "`figure` performs no provider dispatch. GPU-resident arrays passed to later plotting calls may still remain on device when the renderer supports that path."
  ]
}