-
-
Notifications
You must be signed in to change notification settings - Fork 11
/
Copy pathstrings.html
925 lines (698 loc) · 52.7 KB
/
strings.html
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
<!DOCTYPE html>
<html lang="en" data-content_root="../../" data-theme="light">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>NpyString API — NumPy v2.3.dev0 Manual</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "light";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!--
this give us a css class that will be invisible only if js is disabled
-->
<noscript>
<style>
.pst-js-only { display: none !important; }
</style>
</noscript>
<!-- Loaded before other Sphinx assets -->
<link href="../../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link href="../../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=8f2a1f02" />
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
<link rel="stylesheet" type="text/css" href="../../_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Vibur" />
<link rel="stylesheet" type="text/css" href="../../_static/jupyterlite_sphinx.css?v=2c9f8f05" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="../../_static/numpy.css?v=a1b581f7" />
<!-- So that users can add custom icons -->
<script src="../../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
<link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
<script src="../../_static/documentation_options.js?v=5f219352"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../_static/copybutton.js?v=30646c52"></script>
<script src="../../_static/jupyterlite_sphinx.js?v=96e329c5"></script>
<script src="../../_static/design-tabs.js?v=f930bc37"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'reference/c-api/strings';</script>
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.16.1';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://numpy.org/doc/_static/versions.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'devdocs';
DOCUMENTATION_OPTIONS.show_version_warning_banner =
true;
</script>
<link rel="icon" href="../../_static/favicon.ico"/>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="next" title="NumPy core math library" href="coremath.html" />
<link rel="prev" title="Generalized universal function API" href="generalized-ufuncs.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
<meta name="docsearch:version" content="2.3.dev0" />
<meta name="docbuild:last-update" content="Apr 20, 2025"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="light">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<dialog id="pst-search-dialog">
<form class="bd-search d-flex align-items-center"
action="../../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form>
</dialog>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="../../index.html">
<img src="../../_static/numpylogo.svg" class="logo__image only-light" alt="NumPy v2.3.dev0 Manual - Home"/>
<img src="../../_static/numpylogo_dark.svg" class="logo__image only-dark pst-js-only" alt="NumPy v2.3.dev0 Manual - Home"/>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../user/index.html">
User Guide
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="../index.html">
API reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../building/index.html">
Building from source
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../dev/index.html">
Development
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../release.html">
Release notes
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://numpy.org/numpy-tutorials/">
Learn
</a>
</li>
<li class="nav-item dropdown">
<button class="btn dropdown-toggle nav-item" type="button"
data-bs-toggle="dropdown" aria-expanded="false"
aria-controls="pst-nav-more-links">
More
</button>
<ul id="pst-nav-more-links" class="dropdown-menu">
<li class=" ">
<a class="nav-link dropdown-item nav-external" href="https://numpy.org/neps">
NEPs
</a>
</li>
</ul>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button></div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-2"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-2"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-2"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-2">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/numpy/numpy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<dialog id="pst-primary-sidebar-modal"></dialog>
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../user/index.html">
User Guide
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="../index.html">
API reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../building/index.html">
Building from source
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../dev/index.html">
Development
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="../../release.html">
Release notes
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://numpy.org/numpy-tutorials/">
Learn
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://numpy.org/neps">
NEPs
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<button class="btn btn-sm pst-navbar-icon search-button search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button></div>
<div class="navbar-item">
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
</button></div>
<div class="navbar-item">
<div class="version-switcher__container dropdown pst-js-only">
<button id="pst-version-switcher-button-3"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-3"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-3"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-3">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/numpy/numpy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../module_structure.html">NumPy’s module structure</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../arrays.html">Array objects</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../ufuncs.html">Universal functions (<code class="xref py py-class docutils literal notranslate"><span class="pre">ufunc</span></code>)</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../routines.html">Routines and objects by topic</a></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../typing.html">Typing (<code class="xref py py-mod docutils literal notranslate"><span class="pre">numpy.typing</span></code>)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../distutils.html">Packaging</a></li>
</ul>
<ul class="current nav bd-sidenav">
<li class="toctree-l1 current active has-children"><a class="reference internal" href="index.html">NumPy C-API</a><details open="open"><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="types-and-structures.html">Python types and C-structures</a></li>
<li class="toctree-l2"><a class="reference internal" href="config.html">System configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="dtype.html">Data type API</a></li>
<li class="toctree-l2"><a class="reference internal" href="array.html">Array API</a></li>
<li class="toctree-l2"><a class="reference internal" href="iterator.html">Array iterator API</a></li>
<li class="toctree-l2"><a class="reference internal" href="ufunc.html">ufunc API</a></li>
<li class="toctree-l2"><a class="reference internal" href="generalized-ufuncs.html">Generalized universal function API</a></li>
<li class="toctree-l2 current active"><a class="current reference internal" href="#">NpyString API</a></li>
<li class="toctree-l2"><a class="reference internal" href="coremath.html">NumPy core math library</a></li>
<li class="toctree-l2"><a class="reference internal" href="datetimes.html">Datetime API</a></li>
<li class="toctree-l2"><a class="reference internal" href="deprecations.html">C API deprecations</a></li>
<li class="toctree-l2"><a class="reference internal" href="data_memory.html">Memory management in NumPy</a></li>
</ul>
</details></li>
</ul>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../array_api.html">Array API standard compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="../simd/index.html">CPU/SIMD optimizations</a></li>
<li class="toctree-l1"><a class="reference internal" href="../thread_safety.html">Thread Safety</a></li>
<li class="toctree-l1"><a class="reference internal" href="../global_state.html">Global Configuration Options</a></li>
<li class="toctree-l1"><a class="reference internal" href="../security.html">NumPy security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../distutils_status_migration.html">Status of <code class="docutils literal notranslate"><span class="pre">numpy.distutils</span></code> and migration advice</a></li>
<li class="toctree-l1"><a class="reference internal" href="../distutils_guide.html"><code class="docutils literal notranslate"><span class="pre">numpy.distutils</span></code> user guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="../swig.html">NumPy and SWIG</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
<div class="sidebar-primary-item">
<div id="ethical-ad-placement"
class="flat"
data-ea-publisher="readthedocs"
data-ea-type="readthedocs-sidebar"
data-ea-manual="true">
</div></div>
</div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="../../index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="../index.html" class="nav-link">NumPy reference</a></li>
<li class="breadcrumb-item"><a href="index.html" class="nav-link">NumPy C-API</a></li>
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">NpyString API</span></li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="npystring-api">
<h1>NpyString API<a class="headerlink" href="#npystring-api" title="Link to this heading">#</a></h1>
<div class="versionadded">
<p><span class="versionmodified added">New in version 2.0.</span></p>
</div>
<p>This API allows access to the UTF-8 string data stored in NumPy StringDType
arrays. See <a class="reference external" href="https://numpy.org/neps/nep-0055-string_dtype.html#nep55" title="(in NumPy Enhancement Proposals)"><span class="xref std std-ref">NEP-55</span></a> for
more in-depth details into the design of StringDType.</p>
<section id="examples">
<h2>Examples<a class="headerlink" href="#examples" title="Link to this heading">#</a></h2>
<section id="loading-a-string">
<h3>Loading a String<a class="headerlink" href="#loading-a-string" title="Link to this heading">#</a></h3>
<p>Say we are writing a ufunc implementation for <code class="docutils literal notranslate"><span class="pre">StringDType</span></code>. If we are given
<code class="docutils literal notranslate"><span class="pre">const</span> <span class="pre">char</span> <span class="pre">*buf</span></code> pointer to the beginning of a <code class="docutils literal notranslate"><span class="pre">StringDType</span></code> array entry, and a
<code class="docutils literal notranslate"><span class="pre">PyArray_Descr</span> <span class="pre">*</span></code> pointer to the array descriptor, one can
access the underlying string data like so:</p>
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="n">npy_string_allocator</span><span class="w"> </span><span class="o">*</span><span class="n">allocator</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">NpyString_acquire_allocator</span><span class="p">(</span>
<span class="w"> </span><span class="p">(</span><span class="n">PyArray_StringDTypeObject</span><span class="w"> </span><span class="o">*</span><span class="p">)</span><span class="n">descr</span><span class="p">);</span>
<span class="n">npy_static_string</span><span class="w"> </span><span class="n">sdata</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{</span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="nb">NULL</span><span class="p">};</span>
<span class="n">npy_packed_static_string</span><span class="w"> </span><span class="o">*</span><span class="n">packed_string</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">npy_packed_static_string</span><span class="w"> </span><span class="o">*</span><span class="p">)</span><span class="n">buf</span><span class="p">;</span>
<span class="kt">int</span><span class="w"> </span><span class="n">is_null</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span>
<span class="n">is_null</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">NpyString_load</span><span class="p">(</span><span class="n">allocator</span><span class="p">,</span><span class="w"> </span><span class="n">packed_string</span><span class="p">,</span><span class="w"> </span><span class="o">&</span><span class="n">sdata</span><span class="p">);</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">is_null</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">-1</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="c1">// failed to load string, set error</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="mi">-1</span><span class="p">;</span>
<span class="p">}</span>
<span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">is_null</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="c1">// handle missing string</span>
<span class="w"> </span><span class="c1">// sdata->buf is NULL</span>
<span class="w"> </span><span class="c1">// sdata->size is 0</span>
<span class="p">}</span>
<span class="k">else</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="c1">// sdata->buf is a pointer to the beginning of a string</span>
<span class="w"> </span><span class="c1">// sdata->size is the size of the string</span>
<span class="p">}</span>
<span class="n">NpyString_release_allocator</span><span class="p">(</span><span class="n">allocator</span><span class="p">);</span>
</pre></div>
</div>
</section>
<section id="packing-a-string">
<h3>Packing a String<a class="headerlink" href="#packing-a-string" title="Link to this heading">#</a></h3>
<p>This example shows how to pack a new string entry into an array:</p>
<div class="highlight-C notranslate"><div class="highlight"><pre><span></span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">str</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">"Hello world"</span><span class="p">;</span>
<span class="kt">size_t</span><span class="w"> </span><span class="n">size</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">11</span><span class="p">;</span>
<span class="n">npy_packed_static_string</span><span class="w"> </span><span class="o">*</span><span class="n">packed_string</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">npy_packed_static_string</span><span class="w"> </span><span class="o">*</span><span class="p">)</span><span class="n">buf</span><span class="p">;</span>
<span class="n">npy_string_allocator</span><span class="w"> </span><span class="o">*</span><span class="n">allocator</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">NpyString_acquire_allocator</span><span class="p">(</span>
<span class="w"> </span><span class="p">(</span><span class="n">PyArray_StringDTypeObject</span><span class="w"> </span><span class="o">*</span><span class="p">)</span><span class="n">descr</span><span class="p">);</span>
<span class="c1">// copy contents of str into packed_string</span>
<span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">NpyString_pack</span><span class="p">(</span><span class="n">allocator</span><span class="p">,</span><span class="w"> </span><span class="n">packed_string</span><span class="p">,</span><span class="w"> </span><span class="n">str</span><span class="p">,</span><span class="w"> </span><span class="n">size</span><span class="p">)</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mi">-1</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="c1">// string packing failed, set error</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="mi">-1</span><span class="p">;</span>
<span class="p">}</span>
<span class="c1">// packed_string contains a copy of "Hello world"</span>
<span class="n">NpyString_release_allocator</span><span class="p">(</span><span class="n">allocator</span><span class="p">);</span>
</pre></div>
</div>
</section>
</section>
<section id="types">
<h2>Types<a class="headerlink" href="#types" title="Link to this heading">#</a></h2>
<dl class="c type">
<dt class="sig sig-object c" id="c.npy_packed_static_string">
<span class="k"><span class="pre">type</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">npy_packed_static_string</span></span></span><a class="headerlink" href="#c.npy_packed_static_string" title="Link to this definition">#</a><br /></dt>
<dd><p>An opaque struct that represents “packed” encoded strings. Individual
entries in array buffers are instances of this struct. Direct access
to the data in the struct is undefined and future version of the library may
change the packed representation of strings.</p>
</dd></dl>
<dl class="c type">
<dt class="sig sig-object c" id="c.npy_static_string">
<span class="k"><span class="pre">type</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">npy_static_string</span></span></span><a class="headerlink" href="#c.npy_static_string" title="Link to this definition">#</a><br /></dt>
<dd><p>An unpacked string allowing access to the UTF-8 string data.</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">typedef</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">npy_unpacked_static_string</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">size</span><span class="p">;</span>
<span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">buf</span><span class="p">;</span>
<span class="p">}</span><span class="w"> </span><span class="n">npy_static_string</span><span class="p">;</span>
</pre></div>
</div>
<dl class="c member">
<dt class="sig sig-object c" id="c.npy_static_string.size">
<span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">size</span></span></span><a class="headerlink" href="#c.npy_static_string.size" title="Link to this definition">#</a><br /></dt>
<dd><p>The size of the string, in bytes.</p>
</dd></dl>
<dl class="c member">
<dt class="sig sig-object c" id="c.npy_static_string.buf">
<span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">buf</span></span></span><a class="headerlink" href="#c.npy_static_string.buf" title="Link to this definition">#</a><br /></dt>
<dd><p>The string buffer. Holds UTF-8-encoded bytes. Does not currently end in
a null string but we may decide to add null termination in the
future, so do not rely on the presence or absence of null-termination.</p>
<p>Note that this is a <code class="docutils literal notranslate"><span class="pre">const</span></code> buffer. If you want to alter an
entry in an array, you should create a new string and pack it
into the array entry.</p>
</dd></dl>
</dd></dl>
<dl class="c type">
<dt class="sig sig-object c" id="c.npy_string_allocator">
<span class="k"><span class="pre">type</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">npy_string_allocator</span></span></span><a class="headerlink" href="#c.npy_string_allocator" title="Link to this definition">#</a><br /></dt>
<dd><p>An opaque pointer to an object that handles string allocation.
Before using the allocator, you must acquire the allocator lock and release
the lock after you are done interacting with strings managed by the
allocator.</p>
</dd></dl>
<dl class="c type">
<dt class="sig sig-object c" id="c.PyArray_StringDTypeObject">
<span class="k"><span class="pre">type</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">PyArray_StringDTypeObject</span></span></span><a class="headerlink" href="#c.PyArray_StringDTypeObject" title="Link to this definition">#</a><br /></dt>
<dd><p>The C struct backing instances of StringDType in Python. Attributes store
the settings the object was created with, an instance of
<code class="docutils literal notranslate"><span class="pre">npy_string_allocator</span></code> that manages string allocations for arrays
associated with the DType instance, and several attributes caching
information about the missing string object that is commonly needed in cast
and ufunc loop implementations.</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">typedef</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="p">{</span>
<span class="w"> </span><span class="n">PyArray_Descr</span><span class="w"> </span><span class="n">base</span><span class="p">;</span>
<span class="w"> </span><span class="n">PyObject</span><span class="w"> </span><span class="o">*</span><span class="n">na_object</span><span class="p">;</span>
<span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="n">coerce</span><span class="p">;</span>
<span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="n">has_nan_na</span><span class="p">;</span>
<span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="n">has_string_na</span><span class="p">;</span>
<span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="n">array_owned</span><span class="p">;</span>
<span class="w"> </span><span class="n">npy_static_string</span><span class="w"> </span><span class="n">default_string</span><span class="p">;</span>
<span class="w"> </span><span class="n">npy_static_string</span><span class="w"> </span><span class="n">na_name</span><span class="p">;</span>
<span class="w"> </span><span class="n">npy_string_allocator</span><span class="w"> </span><span class="o">*</span><span class="n">allocator</span><span class="p">;</span>
<span class="p">}</span><span class="w"> </span><span class="n">PyArray_StringDTypeObject</span><span class="p">;</span>
</pre></div>
</div>
<dl class="c member">
<dt class="sig sig-object c" id="c.PyArray_StringDTypeObject.base">
<a class="reference internal" href="types-and-structures.html#c.PyArray_Descr" title="PyArray_Descr"><span class="n"><span class="pre">PyArray_Descr</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">base</span></span></span><a class="headerlink" href="#c.PyArray_StringDTypeObject.base" title="Link to this definition">#</a><br /></dt>
<dd><p>The base object. Use this member to access fields common to all
descriptor objects.</p>
</dd></dl>
<dl class="c member">
<dt class="sig sig-object c" id="c.PyArray_StringDTypeObject.na_object">
<a class="reference external" href="https://docs.python.org/3/c-api/structures.html#c.PyObject" title="(in Python v3.13)"><span class="n"><span class="pre">PyObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">na_object</span></span></span><a class="headerlink" href="#c.PyArray_StringDTypeObject.na_object" title="Link to this definition">#</a><br /></dt>
<dd><p>A reference to the object representing the null value. If there is no
null value (the default) this will be NULL.</p>
</dd></dl>
<dl class="c member">
<dt class="sig sig-object c" id="c.PyArray_StringDTypeObject.coerce">
<span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">coerce</span></span></span><a class="headerlink" href="#c.PyArray_StringDTypeObject.coerce" title="Link to this definition">#</a><br /></dt>
<dd><p>1 if string coercion is enabled, 0 otherwise.</p>
</dd></dl>
<dl class="c member">
<dt class="sig sig-object c" id="c.PyArray_StringDTypeObject.has_nan_na">
<span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">has_nan_na</span></span></span><a class="headerlink" href="#c.PyArray_StringDTypeObject.has_nan_na" title="Link to this definition">#</a><br /></dt>
<dd><p>1 if the missing string object (if any) is NaN-like, 0 otherwise.</p>
</dd></dl>
<dl class="c member">
<dt class="sig sig-object c" id="c.PyArray_StringDTypeObject.has_string_na">
<span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">has_string_na</span></span></span><a class="headerlink" href="#c.PyArray_StringDTypeObject.has_string_na" title="Link to this definition">#</a><br /></dt>
<dd><p>1 if the missing string object (if any) is a string, 0 otherwise.</p>
</dd></dl>
<dl class="c member">
<dt class="sig sig-object c" id="c.PyArray_StringDTypeObject.array_owned">
<span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">array_owned</span></span></span><a class="headerlink" href="#c.PyArray_StringDTypeObject.array_owned" title="Link to this definition">#</a><br /></dt>
<dd><p>1 if an array owns the StringDType instance, 0 otherwise.</p>
</dd></dl>
<dl class="c member">
<dt class="sig sig-object c" id="c.PyArray_StringDTypeObject.default_string">
<a class="reference internal" href="#c.npy_static_string" title="npy_static_string"><span class="n"><span class="pre">npy_static_string</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">default_string</span></span></span><a class="headerlink" href="#c.PyArray_StringDTypeObject.default_string" title="Link to this definition">#</a><br /></dt>
<dd><p>The default string to use in operations. If the missing string object
is a string, this will contain the string data for the missing string.</p>
</dd></dl>
<dl class="c member">
<dt class="sig sig-object c" id="c.PyArray_StringDTypeObject.na_name">
<a class="reference internal" href="#c.npy_static_string" title="npy_static_string"><span class="n"><span class="pre">npy_static_string</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">na_name</span></span></span><a class="headerlink" href="#c.PyArray_StringDTypeObject.na_name" title="Link to this definition">#</a><br /></dt>
<dd><p>The name of the missing string object, if any. An empty string
otherwise.</p>
</dd></dl>
<dl class="c member">
<dt class="sig sig-object c" id="c.PyArray_StringDTypeObject.allocator">
<a class="reference internal" href="#c.npy_string_allocator" title="npy_string_allocator"><span class="n"><span class="pre">npy_string_allocator</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">allocator</span></span></span><a class="headerlink" href="#c.PyArray_StringDTypeObject.allocator" title="Link to this definition">#</a><br /></dt>
<dd><p>The allocator instance associated with the array that owns this
descriptor instance. The allocator should only be directly accessed
after acquiring the allocator_lock and the lock should be released
immediately after the allocator is no longer needed</p>
</dd></dl>
</dd></dl>
</section>
<section id="functions">
<h2>Functions<a class="headerlink" href="#functions" title="Link to this heading">#</a></h2>
<dl class="c function">
<dt class="sig sig-object c" id="c.NpyString_acquire_allocator">
<a class="reference internal" href="#c.npy_string_allocator" title="npy_string_allocator"><span class="n"><span class="pre">npy_string_allocator</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">NpyString_acquire_allocator</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#c.PyArray_StringDTypeObject" title="PyArray_StringDTypeObject"><span class="n"><span class="pre">PyArray_StringDTypeObject</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">descr</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.NpyString_acquire_allocator" title="Link to this definition">#</a><br /></dt>
<dd><p>Acquire the mutex locking the allocator attached to
<code class="docutils literal notranslate"><span class="pre">descr</span></code>. <code class="docutils literal notranslate"><span class="pre">NpyString_release_allocator</span></code> must be called on the allocator
returned by this function exactly once. Note that functions requiring the
GIL should not be called while the allocator mutex is held, as doing so may
cause deadlocks.</p>
</dd></dl>
<dl class="c function">
<dt class="sig sig-object c" id="c.NpyString_acquire_allocators">
<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NpyString_acquire_allocators</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">n_descriptors</span></span>, <a class="reference internal" href="types-and-structures.html#c.PyArray_Descr" title="PyArray_Descr"><span class="n"><span class="pre">PyArray_Descr</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">descrs</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span>, <a class="reference internal" href="#c.npy_string_allocator" title="npy_string_allocator"><span class="n"><span class="pre">npy_string_allocator</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">allocators</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.NpyString_acquire_allocators" title="Link to this definition">#</a><br /></dt>
<dd><p>Simultaneously acquire the mutexes locking the allocators attached to
multiple descriptors. Writes a pointer to the associated allocator in the
allocators array for each StringDType descriptor in the array. If any of
the descriptors are not StringDType instances, write NULL to the allocators
array for that entry.</p>
<p><code class="docutils literal notranslate"><span class="pre">n_descriptors</span></code> is the number of descriptors in the descrs array that
should be examined. Any descriptor after <code class="docutils literal notranslate"><span class="pre">n_descriptors</span></code> elements is
ignored. A buffer overflow will happen if the <code class="docutils literal notranslate"><span class="pre">descrs</span></code> array does not
contain n_descriptors elements.</p>
<p>If pointers to the same descriptor are passed multiple times, only acquires
the allocator mutex once but sets identical allocator pointers appropriately.
The allocator mutexes must be released after this function returns, see
<code class="docutils literal notranslate"><span class="pre">NpyString_release_allocators</span></code>.</p>
<p>Note that functions requiring the GIL should not be called while the
allocator mutex is held, as doing so may cause deadlocks.</p>
</dd></dl>
<dl class="c function">
<dt class="sig sig-object c" id="c.NpyString_release_allocator">
<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NpyString_release_allocator</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.npy_string_allocator" title="npy_string_allocator"><span class="n"><span class="pre">npy_string_allocator</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">allocator</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.NpyString_release_allocator" title="Link to this definition">#</a><br /></dt>
<dd><p>Release the mutex locking an allocator. This must be called exactly once
after acquiring the allocator mutex and all operations requiring the
allocator are done.</p>
<p>If you need to release multiple allocators, see
NpyString_release_allocators, which can correctly handle releasing the
allocator once when given several references to the same allocator.</p>
</dd></dl>
<dl class="c function">
<dt class="sig sig-object c" id="c.NpyString_release_allocators">
<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NpyString_release_allocators</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">length</span></span>, <a class="reference internal" href="#c.npy_string_allocator" title="npy_string_allocator"><span class="n"><span class="pre">npy_string_allocator</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">allocators</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.NpyString_release_allocators" title="Link to this definition">#</a><br /></dt>
<dd><p>Release the mutexes locking N allocators. <code class="docutils literal notranslate"><span class="pre">length</span></code> is the length of the
allocators array. NULL entries are ignored.</p>
<p>If pointers to the same allocator are passed multiple times, only releases
the allocator mutex once.</p>
</dd></dl>
<dl class="c function">
<dt class="sig sig-object c" id="c.NpyString_load">
<span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NpyString_load</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.npy_string_allocator" title="npy_string_allocator"><span class="n"><span class="pre">npy_string_allocator</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">allocator</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#c.npy_packed_static_string" title="npy_packed_static_string"><span class="n"><span class="pre">npy_packed_static_string</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">packed_string</span></span>, <a class="reference internal" href="#c.npy_static_string" title="npy_static_string"><span class="n"><span class="pre">npy_static_string</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">unpacked_string</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.NpyString_load" title="Link to this definition">#</a><br /></dt>
<dd><p>Extract the packed contents of <code class="docutils literal notranslate"><span class="pre">packed_string</span></code> into <code class="docutils literal notranslate"><span class="pre">unpacked_string</span></code>.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">unpacked_string</span></code> is a read-only view onto the <code class="docutils literal notranslate"><span class="pre">packed_string</span></code> data
and should not be used to modify the string data. If <code class="docutils literal notranslate"><span class="pre">packed_string</span></code> is
the null string, sets <code class="docutils literal notranslate"><span class="pre">unpacked_string.buf</span></code> to the NULL
pointer. Returns -1 if unpacking the string fails, returns 1 if
<code class="docutils literal notranslate"><span class="pre">packed_string</span></code> is the null string, and returns 0 otherwise.</p>
<p>A useful pattern is to define a stack-allocated npy_static_string instance
initialized to <code class="docutils literal notranslate"><span class="pre">{0,</span> <span class="pre">NULL}</span></code> and pass a pointer to the stack-allocated
unpacked string to this function. This function can be used to
simultaneously unpack a string and determine if it is a null string.</p>
</dd></dl>
<dl class="c function">
<dt class="sig sig-object c" id="c.NpyString_pack_null">
<span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NpyString_pack_null</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.npy_string_allocator" title="npy_string_allocator"><span class="n"><span class="pre">npy_string_allocator</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">allocator</span></span>, <a class="reference internal" href="#c.npy_packed_static_string" title="npy_packed_static_string"><span class="n"><span class="pre">npy_packed_static_string</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">packed_string</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.NpyString_pack_null" title="Link to this definition">#</a><br /></dt>
<dd><p>Pack the null string into <code class="docutils literal notranslate"><span class="pre">packed_string</span></code>. Returns 0 on success and -1 on
failure.</p>
</dd></dl>
<dl class="c function">
<dt class="sig sig-object c" id="c.NpyString_pack">
<span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NpyString_pack</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#c.npy_string_allocator" title="npy_string_allocator"><span class="n"><span class="pre">npy_string_allocator</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">allocator</span></span>, <a class="reference internal" href="#c.npy_packed_static_string" title="npy_packed_static_string"><span class="n"><span class="pre">npy_packed_static_string</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">packed_string</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">buf</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">size</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.NpyString_pack" title="Link to this definition">#</a><br /></dt>
<dd><p>Copy and pack the first <code class="docutils literal notranslate"><span class="pre">size</span></code> entries of the buffer pointed to by <code class="docutils literal notranslate"><span class="pre">buf</span></code>
into the <code class="docutils literal notranslate"><span class="pre">packed_string</span></code>. Returns 0 on success and -1 on failure.</p>
</dd></dl>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="generalized-ufuncs.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Generalized universal function API</p>
</div>
</a>
<a class="right-next"
href="coremath.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">NumPy core math library</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<dialog id="pst-secondary-sidebar-modal"></dialog>
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#examples">Examples</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#loading-a-string">Loading a String</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#packing-a-string">Packing a String</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#types">Types</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#functions">Functions</a></li>
</ul>
</nav></div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script defer src="../../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
<script defer src="../../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2008-2025, NumPy Developers.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
</p></div>
</div>
</div>
</footer>
</body>
</html>