-
Notifications
You must be signed in to change notification settings - Fork 12
/
physica-manual.typ
1263 lines (1021 loc) · 33.2 KB
/
physica-manual.typ
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
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2023 Leedehai
// This document is shared under the Creative Commons BY-ND 4.0 license.
#import "physica.typ": *
#let version = "0.9.4"
#set document(
title: [physica-manual.typ],
author: ("Leedehai"),
// Prevents setting the creation date to PDF metadata, so the same *.typ
// file content will result in the same *.pdf binary.
date: none,
)
#set page(
numbering: "1/1",
header: align(right)[#text(8pt)[The `physica` package\ version #version]],
)
#set heading(numbering: "1.")
#align(center, text(16pt)[*The `physica` package*])
#let linkurl(s, url) = {
link(url)[#underline(text(fill: blue, s))]
}
#align(center)[
Leedehai \
#linkurl("GitHub", "https://github.com/leedehai/typst-physics") |
#linkurl("Typst", "https://typst.app/docs/packages/")
]
#set par(justify: true)
#v(1em)
#align(center)[
/ physica: _noun_. Latin, study of nature.
]
#v(1em)
#outline(indent: true)
#pagebreak(weak: true)
= Introduction
#v(1em)
#linkurl("Typst", "https://typst.app") is typesetting framework aiming to become the next generation alternative to LATEX. It excels in its friendly user experience and performance.
The `physica` package provides handy Typst typesetting functions that make academic writing for natural sciences simpler and faster, by simplifying otherwise very complex and repetitive expressions in the domain of natural sciences.
This manual itself was generated using the Typst CLI and the `physica` package, so hopefully this document is able to provide you with a sufficiently self evident demonstration of how this package shall be used.
= Using `physica`
#v(1em)
With `typst`'s #linkurl("package management", "https://github.com/typst/packages"):
```typst
#import "@preview/physica:0.9.4": *
$ curl (grad f), pdv(,x,y,z,[2,k]), tensor(Gamma,+k,-i,-j) = pdv(vb(e_i),x^j)vb(e^k) $
```
$ curl (grad f), pdv(,x,y,z,[2,k]), tensor(Gamma,+k,-i,-j)=pdv(vb(e_i),x^j)vb(e^k) $
= The symbols
#v(1em)
// Put the superscript *before* the symbol, in case there are symbols after it.
#let builtin(symbol) = [#super(text(fill: blue, "typst "))#symbol]
#let hl(s) = { // Highlight. Usage: hl("..."), hl(`...`)
show regex("#\(.+?\)|#(\d|\w)+"): set text(eastern)
show regex("\[|\]"): set text(red)
show regex("\w+:"): set text(blue)
show regex(";"): set text(red, weight: "bold")
s
}
#let SUM = $limits(sum)_(i=0)^n i$
Some symbols are already provided as a Typst built-in. They are listed here just for completeness with annotation like #builtin([`this`]), as users coming from LATEX might not know they are already available in Typst out of box.
All symbols need to be used in *math mode* `$...$`.
== Braces
#v(1em)
#table(
columns: (auto, auto, auto, auto),
align: left,
stroke: none,
[*Symbol*], [*Abbr.*], [*Example*], [*Notes*],
[#builtin([`abs(`_content_`)`])],
[],
[`abs(phi(x))` #sym.arrow $abs(phi(x))$],
[absolute],
[#builtin([`norm(`_content_`)`])],
[],
[`norm(phi(x))` #sym.arrow $norm(phi(x))$],
[norm],
[`Order(`_content_`)`],
[],
[`Order(x^2)` #sym.arrow $Order(x^2)$],
[big O],
[`order(`_content_`)`],
[],
[`order(1)` #sym.arrow $order(1)$],
[small O],
[`Set(`_content_`)`],
[],
[
`Set(a_n), Set(a_i, forall i)` \ #sym.arrow $Set(a_n), Set(a_i, forall i)$ \
`Set(vec(1,n), forall n)` \ #sym.arrow $Set(vec(1,n), forall n)$
],
[math set, use `Set` not `set` since the latter is a Typst keyword],
[`evaluated(`_content_`)`],
[`eval`],
[
`eval(f(x))_0^infinity` \ #sym.arrow $eval(f(x))_0^infinity$ \
`eval(f(x)/g(x))_0^1` \ #sym.arrow $eval(f(x)/g(x))_0^1$
],
[attach a vertical bar on the right to denote evaluation boundaries],
[`expectationvalue`],
[`expval`],
[
`expval(u)` #sym.arrow $expval(u)$ \
`expval(p,psi)` #sym.arrow $expval(p,psi)$ \
],
[expectation value, also see bra-ket @dirac-braket below],
)
== Vector notations
#v(1em)
#table(
columns: (5fr, 2fr, auto, 5fr),
align: left,
stroke: none,
[*Symbol*], [*Abbr.*], [*Example*], [*Notes*],
[#builtin([`vec(`...`)`])],
[],
[`vec(1,2)` #sym.arrow $vec(1,2)$],
[column vector],
[`vecrow(`...`)`],
[],
[
`vecrow(alpha, b)` \ #sym.arrow $vecrow(alpha, b)$ \
`vecrow(sum_0^n i, b, delim:"[")` \ #sym.arrow $vecrow(sum_0^n i,b,delim:"[")$ \
],
[row vector],
[`TT`],
[],
[`v^TT, A^TT` #sym.arrow $v^TT, A^TT$],
[transpose, also see\ @matrix-transpose],
[`vectorbold(`_content_`)`],
[`vb`],
[`vb(a),vb(mu_1)` #sym.arrow $vb(a),vb(mu_1)$],
[vector, bold],
[`vectorunit(`_content_`)`],
[`vu`],
[`vu(a),vu(mu_1)` #sym.arrow $vu(a),vu(mu_1)$],
[unit vector],
[`vectorarrow(`_content_`)`],
[`va`],
[`va(a),va(mu_1)` #sym.arrow $va(a),va(mu_1)$],
[vector, arrow \ #sub[(not bold: see ISO 80000-2:2019)]],
[`grad`],
[],
[`grad f` #sym.arrow $grad f$],
[gradient],
[`div`],
[],
[`div vb(E)` #sym.arrow $div vb(E)$],
[divergence],
[`curl`],
[],
[`curl vb(B)` #sym.arrow $curl vb(B)$],
[curl],
[`laplacian`],
[],
[`diaer(u) = c^2 laplacian u` \ #sym.arrow $diaer(u) = c^2 laplacian u$],
[Laplacian,\ not #builtin(`laplace`) $laplace$],
[`dotproduct`],
[`dprod`],
[`a dprod b` #sym.arrow $a dprod b$],
[dot product],
[`crossproduct`],
[`cprod`],
[`a cprod b` #sym.arrow $a cprod b$],
[cross product],
[`innerproduct`],
[`iprod`],
[
`iprod(u, v)` #sym.arrow $iprod(u, v)$ \
`iprod(sum_i a_i, b)` \ #sym.arrow $iprod(sum_i a_i, b)$
],
[inner product],
)
== Matrix notations
#v(1em)
=== Determinant, (anti-)diagonal, identity, zero matrix
#table(
columns: (auto, auto, auto, auto),
align: left,
stroke: none,
[*Symbol*], [*Abbr.*], [*Example*], [*Notes*],
[`TT`],
[],
[`v^TT, A^TT` #sym.arrow $v^TT, A^TT$],
[transpose, also see\ @matrix-transpose],
[#builtin([`mat(`...`)`])],
[],
[`mat(1,2;3,4)` #sym.arrow $mat(1,2;3,4)$],
[matrix],
[`matrixdet(`...`)`],
[`mdet`],
[
#hl(`mdet(1,x;1,y)`) #sym.arrow $mdet(1,x;1,y)$
],
[matrix determinant],
[`diagonalmatrix(`...`)`],
[`dmat`],
[
`dmat(1,2)` #sym.arrow $dmat(1,2)$ \
#hl(`dmat(1,a,xi,delim:"[",fill:0)`) \ #sym.arrow $dmat(1,a,xi,delim:"[",fill:0)$
],
[diagonal matrix],
[`antidiagonalmatrix(`...`)`],
[`admat`],
[
`admat(1,2)` #sym.arrow $admat(1,2)$ \
#hl(`admat(1,a,xi,delim:"[",fill:dot)`) \ #sym.arrow $admat(1,a,xi,delim:"[",fill:dot)$
],
[anti-diagonal matrix],
[`identitymatrix(`...`)`],
[`imat`],
[
`imat(2)` #sym.arrow $imat(2)$ \
#hl(`imat(3,delim:"[",fill:*)`) #sym.arrow \ $imat(3,delim:"[",fill:*)$
],
[identity matrix],
[`zeromatrix(`...`)`],
[`zmat`],
[
`zmat(2)` #sym.arrow $zmat(2)$ \
#hl(`zmat(3,delim:"[")`) #sym.arrow \ $zmat(3,delim:"[")$
],
[zero matrix],
)
=== Jacobian matrix
`jacobianmatrix(`...`)`, i.e. `jmat(`...`)`.
#table(
columns: (25%, auto, auto),
align: center,
stroke: none,
column-gutter: 1em,
[
\ Typst (like LaTeX) \ cramps fractions in a matrix...
],
[
#hl(`jmat(f_1,f_2; x,y)`)
$ jmat(f_1,f_2;x,y) $
],
[
#hl(`jmat(f,g; x,y,z; delim:"[")`)
$ jmat(f,g;x,y,z;delim:"[") $
],
[
\ ...but you can uncramp them using argument #hl(`big:#true`) here
],
[
#hl(`jmat(f_1,f_2;x,y;big:#true)`)
$ jmat(f_1,f_2;x,y;big:#true) $
],
[
#hl(`jmat(f,g;x,y,z;delim:"|",big:#true)`)
$ jmat(f,g;x,y,z;delim:"|",big:#true) $
],
)
=== Hessian matrix
`hessianmatrix(`...`)`, i.e. `hmat(`...`)`.
#table(
columns: (25%, auto, auto),
align: center,
stroke: none,
column-gutter: 1em,
[
\ Typst (like LaTeX) \ cramps fractions in a matrix...
],
[
#hl(`hmat(f; x,y)`)
$ hmat(f; x,y) $
],
[
#hl(`hmat(; x,y,z; delim:"[")`)
$ hmat(; x,y,z; delim:"[") $
],
[
\ ...but you can uncramp them using argument #hl(`big:#true`) here
],
[
#hl(`hmat(f;x,y;big:#true)`)
$ hmat(f;x,y;big:#true) $
],
[
#hl(`hmat(;x,y,z;delim:"|",big:#true)`)
$ hmat(; x,y,z;delim:"|",big:#true) $
],
)
=== Matrix with an element builder
`xmatrix(`_m, n, func_`)`, i.e. `xmat(`...`)`. The element building function
_func_ takes two integers which are the row and column numbers starting from 1.
#table(
columns: (auto, auto),
align: left,
stroke: none,
column-gutter: 1em,
[
#hl(`#let g = (i,j) => $g^(#(i - 1)#(j - 1))$
xmat(2, 2, #g)`)
$ #let g = (i,j) => $g^(#(i - 1)#(j - 1))$
xmat(2, 2, #g) $
],
)
=== Rotation matrices, 2D and 3D
#table(
columns: (auto, auto, auto),
align: center,
stroke: none,
column-gutter: 1em,
[
#hl(`rot2mat(theta)`)
$ rot2mat(theta) $
],
[
#hl(`rot2mat(-a/2,delim:"[")`)
$ rot2mat(-a/2, delim:"[") $
],
[
#hl(`rot2mat(display(a/2),delim:"[")`)
$ rot2mat(display(a/2),delim:"[") $
],
[
#hl(`rot3xmat(theta)`)
$ rot3xmat(theta) $
],
[
#hl(`rot3ymat(45^degree)`)
$ rot3ymat(45^degree) $
],
[
#hl(`rot3zmat(theta,delim:"[")`)
$ rot3zmat(theta,delim:"[") $
],
)
=== Gram matrix
#table(
columns: (auto, auto, auto),
align: center,
stroke: none,
column-gutter: 1em,
[
#hl(`grammat(alpha,beta)`)
$ grammat(alpha, beta) $
],
[
#hl(`grammat(v_1,v_2,v_3, delim:"[")`)
$ grammat(v_1,v_2,v_3, delim:"[") $
],
[
#hl(`grammat(v_1,v_2, norm:#true)`)
$ grammat(v_1,v_2, norm:#true) $
],
)
== Dirac braket notations <dirac-braket>
#v(1em)
#table(
columns: (auto, 1fr, 6fr, 3fr),
align: left,
stroke: none,
[*Symbol*], [*Abbr.*], [*Example*], [*Notes*],
[`bra(`_content_`)`],
[],
[
`bra(u)` #sym.arrow $bra(u)$ \
`bra(vec(1,2))` #sym.arrow $bra(vec(1,2))$
],
[bra],
[`ket(`_content_`)`],
[],
[
`ket(u)` #sym.arrow $ket(u)$ \
`ket(vec(1,2))` #sym.arrow $ket(vec(1,2))$
],
[ket],
[`braket(`..`)`],
[],
[
`braket(a), braket(u, v)` \ #sym.arrow $braket(a), braket(u, v)$ \
`braket(psi,A/N,phi)` #sym.arrow $braket(psi,A/N,phi)$
],
[braket, with 1, 2, or 3 arguments],
[`ketbra(`..`)`],
[],
[
`ketbra(a), ketbra(u, v)` \ #sym.arrow $ketbra(a), ketbra(u, v)$ \
`ketbra(a/N, b)` #sym.arrow $ketbra(a/N, b)$
],
[ketbra, with 1 or 2 arguments],
[`expval(`_content_`)`],
[],
[
`expval(u)` #sym.arrow $expval(u)$ \
`expval(A,psi)` #sym.arrow $expval(A,psi)$
],
[expectation],
[`matrixelement(`..`)`],
[`mel`],
[
`mel(n, partial_nu H, m)` \ #sym.arrow $mel(n, partial_nu H, m)$
],
[matrix element, same as `braket(n,M,n)`],
)
== Math functions
#v(1em)
Typst built-in math operators: #linkurl(`math.op`, "https://typst.app/docs/reference/math/op/").
#table(
columns: (auto, auto),
align: left,
stroke: none,
column-gutter: 25pt,
[*Expressions*], [*Results*],
[`sin(x), sinh(x), arcsin(x), asin(x)`],
[$sin(x), sinh(x), arcsin(x), asin(x)$],
[`cos(x), cosh(x), arccos(x), acos(x)`],
[$cos(x), cosh(x), arccos(x), acos(x)$],
[`tan(x), tanh(x), arctan(x), atan(x)`],
[$tan(x), tanh(x), arctan(x), atan(x)$],
[`sec(x), sech(x), arcsec(x), asec(x)`],
[$sec(x), sech(x), arcsec(x), asec(x)$],
[`csc(x), csch(x), arccsc(x), acsc(x)`],
[$csc(x), csch(x), arccsc(x), acsc(x)$],
[`cot(x), coth(x), arccot(x), acot(x)`],
[$cot(x), coth(x), arccot(x), acot(x)$],
)
#table(
columns: (3fr, 3fr, 4fr),
align: left,
stroke: none,
[*Expressions*], [*Results*], [*Notes*],
[#builtin([`Pr(x)`])],
[$Pr(x)$],
[probability],
[#builtin([`exp x`])],
[$exp x$],
[exponential],
[#builtin([`log x, lg x, ln x`])],
[$log x, lg x, ln x$],
[logarithmic],
[`lb x`],
[$lb x$],
[binary logarithm],
[#builtin([`det A`])],
[$det A$],
[matrix determinant],
[`diag(-1,1,1,1)`],
[$diag(-1,1,1,1)$],
[diagonal matrix, compact form (use `dmat` for the "real" matrix form)],
[`trace A, tr A`],
[$trace A, tr A$],
[matrix trace],
[`Trace A, Tr A`],
[$Trace A, Tr A$],
[matrix trace, alt.],
[`rank A`],
[$rank A$],
[matrix rank],
[`erf(x)`],
[$erf(x)$],
[Gauss error function],
[`Res A`],
[$Res A$],
[residue (complex analysis)],
[`Re z, Im z `],
[$Re z, Im z$],
[real, imaginary (complex analysis)],
[`sgn x`],
[$sgn x$],
[sign function],
)
== Differentials and derivatives
#v(1em)
#table(
columns: (auto, 1fr, 6fr, 5fr),
align: left,
stroke: none,
[*Symbol*], [*Abbr.*], [*Example*], [*Notes*],
[`differential(`...`)`],
[`dd`],
[
e.g. $dd(f), dd(x,y), dd(x,3), dd(x,y,p:and)$ \
See @differentials
],
[differential],
[`variation(`...`)`],
[`var`],
[
`var(f)` #sym.arrow $var(f)$ \
`var(x,y)` #sym.arrow $var(x,y)$ \
],
[variation, shorthand of \ `dd(..., d: delta)`],
[`difference(`...`)`],
[],
[
`difference(f)` #sym.arrow $difference(f)$ \
`difference(x,y)` #sym.arrow $difference(x,y)$ \
],
[difference, shorthand of \ `dd(..., d: Delta)`],
[`derivative(`...`)`],
[`dv`],
[
e.g. $dv(,x), dv(f,x), dv(f,x,k,d:Delta), dv(f,x,s:\/)$ \
See @ordinary-derivatives
],
[derivative],
[`partialderivative(`...`)`],
[`pdv`],
[
e.g. $pdv(,x), pdv(f,x), pdv(f,x,y,2), pdv(f,x,y,[2,3]), pdv(f,x,s:\/)$ \
See @partial-derivatives
],
[partial derivative, could be mixed order],
)
=== Differentials <differentials>
#v(1em)
Functions: `differential(`\*_args_, \*\*_kwargs_`)`, abbreviated as `dd(`...`)`.
- positional _args_: the variable names, *optionally* followed by an order number e.g. `2`, or an order array e.g. `[2,3]`, `[k]`, `[m n, lambda+1]`.
- named _kwargs_:
- `d`: the differential symbol [default: `upright(d)`].
- `p`: the product symbol connecting the components [default: `none`].
- `compact`: only effective if `p` is `none`. If `#true`, will remove the TeXBook-advised thin spaces between the d-units [default: `#false`].
TeXBook advises _[f]ormulas involving calculus look best when an extra thin space
appears before dx or dy or d whatever_ (Chapter 18 p.168), and this package
heeds this advice. If you don't want the spaces between the d-units, you may
pass a `compact:#true` argument: $dd(r,theta) "vs." dd(r,theta,compact:#true)$ (compact).
// https://github.com/typst/typst/issues/147 advocates for set rules for
// non built-in functions. When that's implemented, user can do a
// #set dd(compact: true) to set this param for all dd() invocations.
*Order assignment algorithm:*
- If there is no order number or order array, all variables have order 1.
- If there is an order number (not an array), then this order number is assigned to _every_ variable, e.g. `dd(x,y,2)` assigns $x <- 2, y <- 2$.
- If there is an order array, then the orders therein are assigned to the variables in order, e.g. `dd(f,x,y,[2,3])` assigns $x <- 2, y <- 3$.
- If the order array holds fewer elements than the number of variables, then the orders of the remaining variables are 1, e.g. `dd(x,y,z,[2,3])` assigns $x <- 2, y <- 3, z <- 1$.
- If a variable $x$ has order 1, it is rendered as $upright(d) x$ not $upright(d)^1 x$.
#align(center, [*Examples*])
#grid(
columns: (50%, 50%),
row-gutter: 1em,
column-gutter: 2em,
[
*(1)* #hl(`dd(f), f(r,theta) dd(r,theta)`) \
$ dd(f), f(r,theta) dd(r,theta) $
],
[
*(2)* #hl(`dd(x,3), dd(f,[k]), dd(f,[k],d:delta)`) \
$ dd(x,3), dd(f,[k]), dd(f,[k],d:delta) $
],
[
*(3)* #hl(`dd(f,2), dd(vb(x),t,[3,])`) \
$ dd(f,2), dd(vb(x),t,[3,]) $
],
[
*(4)* #hl(`dd(x,y), dd(x,y,[2,3]), dd(x,y,z,[2,3])`) \
$ dd(x,y), dd(x,y,[2,3]), dd(x,y,z,[2,3]) $
],
[
*(5)* #hl(`dd(x, y, z, [[1,1],rho+1,n_1])`) \
$ dd(x, y, z, [[1,1],rho+1,n_1]) $
],
[
*(6)* #hl(`dd(x,y,d:Delta), dd(x,y,2,d:Delta)`) \
$ dd(x,y,d:Delta), dd(x,y,2,d:Delta) $
],
[
*(7)* #hl(`dd(t,x_1,x_2,x_3,p:and)`) \
$ dd(t,x_1,x_2,x_3,p:and) $
],
[
*(7)* #hl(`dd(t,x_1,x_2,x_3,d:upright(D))`) \
$ dd(t,x_1,x_2,x_3,d:upright(D)) $
]
)
=== Ordinary derivatives <ordinary-derivatives>
#v(1em)
Function: `derivative(`_f_, \*_args_, \*\*_kwargs_`)`, abbreviated as `dv(`...`)`.
- _f_: the function, which can be `#none` or omitted,
- positional _args_: the variable name, *optionally* followed by an order number e.g. `2`,
- named _kwargs_:
- `d`: the differential symbol [default: `upright(d)`].
- `s`: the "slash" separating the numerator and denominator [default: `none`], by default it produces the normal fraction form $dv(f,x)$. The most common non-default is `slash` or simply `\/`, so as to create a flat form $dv(f,x,s:\/)$ that fits inline.
*Order assignment algorithm:* there is just one variable, so the assignment is trivial: simply assign the order number (default to 1) to the variable. If a variable $x$ has order 1, it is rendered as $x$ not $x^1$.
#align(center, [*Examples*])
#grid(
columns: (50%, 50%),
row-gutter: 1em,
column-gutter: 2em,
[
*(1)* #hl(`dv(,x), dv(,x,2), dv(f,x,k+1)`) \
$ dv(,x), dv(,x,2), dv(f,x,k+1) $
],
[
*(2)* #hl(`dv(, vb(r)), dv(f, vb(r)_e, 2)`) \
$ dv(, vb(r)), dv(, vb(r)_e, 2) $
],
[
*(3)* #hl(`dv(f,x,2,s:\/), dv(f,xi,k+1,s:slash)`) \
$ dv(f,x,2,s:\/), dv(f,xi,k+1,s:slash) $
],
[
*(4)* #hl(`dv(, x, d:delta), dv(, x, 2, d:Delta)`) \
$ dv(, x, d:delta), dv(, x, 2, d:Delta) $
],
[
*(5)* #hl(`dv(vb(u), t, 2, d: upright(D))`) \
$ dv(vb(u), t, 2, d: upright(D)) $
],
[
*(6)* #hl(`dv(vb(u),t,2,d:upright(D),s:slash)`) \
$ dv(vb(u),t,2,d:upright(D),s:slash) $
],
)
=== Partial derivatives (incl. mixed orders) <partial-derivatives>
#v(1em)
Function: `partialderivative(`_f_, \*_args_, \*\*_kwargs_`)`, abbreviated as `pdv(`...`)`.
- _f_: the function, which can be `#none` or omitted,
- positional _args_: the variable names, *optionally* followed by an order number e.g. `2`, or an order array e.g. `[2,3]`, `[k]`, `[m n, lambda+1]`.
- named _kwargs_:
- `d`: the differential symbol [default: `partial`].
- `s`: the "slash" separating the numerator and denominator [default: `none`], by default it produces the normal fraction form $pdv(f,x)$. The most common non-default is `slash` or simply `\/`, so as to create a flat form $pdv(f,x,s:\/)$ that fits inline.
- `total`: the user-specified total order.
- If it is absent, then (1) if the orders assigned to all variables are numeric, the total order number will be *automatically computed*; (2) if non-number symbols are present, computation will be attempted with minimum effort, and a user override with argument `total` may be necessary.
*Order assignment algorithm:*
- If there is no order number or order array, all variables have order 1.
- If there is an order number (not an array), then this order number is assigned to _every_ variable, e.g. `pdv(f,x,y,2)` assigns $x <- 2, y <- 2$.
- If there is an order array, then the orders therein are assigned to the variables in order, e.g. `pdv(f,x,y,[2,3])` assigns $x <- 2, y <- 3$.
- If the order array holds fewer elements than the number of variables, then the orders of the remaining variables are 1, e.g. `pdv(f,x,y,z,[2,3])` assigns $x <- 2, y <- 3, z <- 1$.
- If a variable $x$ has order 1, it is rendered as $x$, not $x^1$.
#align(center, [*Examples*])
#grid(
columns: (50%, 50%),
row-gutter: 1em,
column-gutter: 2em,
[
*(1)* #hl(`pdv(,x), pdv(,t,2), pdv(,lambda,[k])`) \
$ pdv(,x), pdv(,t,2), pdv(,lambda,[k]) $
],
[
*(2)* #hl(`pdv(f,vb(r)), pdv(phi,vb(r)_e,2)`) \
$ pdv(phi,vb(r)), pdv(phi,vb(r)_e,2) $
],
[
*(3)* #hl(`pdv(,x,y), pdv(,x,y,2)`) \
$ pdv(,x,y), pdv(,x,y,2) $
],
[
*(4)* #hl(`pdv(f,x,y,2), pdv(f,x,y,3)`) \
$ pdv(phi,x,y,2), pdv(phi,x,y,3) $
],
[
*(5)* #hl(`pdv(,x,y,[2,]), pdv(,x,y,[1,2])`) \
$ pdv(,x,y,[2,]), pdv(,x,y,[1,2]) $
],
[
*(6)* #hl(`pdv(,t,2,s:\/), pdv(f,x,y,s:slash)`) \
$ pdv(,t,2,s:\/), pdv(f,x,y,s:slash) $
],
[
*(7)* #hl(`pdv(, (x^1), (x^2), (x^3), [1,3])`) \
$ pdv(, (x^1), (x^2), (x^3), [1,3]) $
],
[
*(8)* #hl(`pdv(phi,x,y,z,tau, [2,2,2,1])`) \
$ pdv(phi,x,y,z,tau, [2,2,2,1]) $
],
[
*(9)* #hl(`pdv(,x,y,z,t,[1,xi,2,eta+2])`) \
$ pdv(,x,y,z,t,[1,xi,2,eta+2]) $
],
[
*(10)* #hl(`pdv(,x,y,z,[xi n,n-1],total:(xi+1)n)`) \
$ pdv(,x,y,z,[xi n,n-1],total:(xi+1)n) $
],
[
*(11)* #hl(`pdv(S, phi.alt, phi.alt, d:delta)`) \
$ pdv(S, phi.alt, phi.alt, d:delta) $
],
[
*(12)* #hl(`pdv(W[J], J^mu (x) J^nu (y), d:delta)`) \
$ pdv(W[J], J^mu (x) J^nu (y), d:delta) $
]
)
*(13)* #hl(`integral_V dd(V) (pdv(cal(L), phi) - partial_mu (pdv(cal(L), (partial_mu phi)))) = 0`) \
$ integral_V dd(V) (pdv(cal(L), phi) - partial_mu (pdv(cal(L), (partial_mu phi)))) = 0 $
== Special show rules
#v(1em)
=== Matrix transpose with superscript T <matrix-transpose>
#v(1em)
Matrix transposition can be simply written as `..^T`, just like handwriting,
and the only superscript `T` will be formatted properly to represent
transposition instead of a normal capital letter $T$.
This $square.stroked.dotted^T => square.stroked.dotted^TT$
conversion is disabled if the base is either
- a `limits(...)` or `scripts(...)` element, or
- an integration $integral$ or sum $sum$ (not greek $Sigma$) or product $product$ (not greek $Pi$) or vertical bar $|$, or
- an equation or `lr(...)` element whose last child is one of the above.
Overrides: if you really want to
- print a transpose explicitly: use symbol `TT`: `A^TT` $=> A^TT$;
- print a superscript letter $T$: use `scripts(T)`: `2^scripts(T)` $=> 2^scripts(T)$.
This feature needs to be enabled explicitly through a _show rule_.
```typ
#show: super-T-as-transpose
(A B)^T = B^T A^T
```
If you only want to enable it within a content block's scope, you may do
```typ
#[
#show: super-T-as-transpose // Enabled from here till the end of block.
(A B)^T = B^T A^T
]
```
#align(center, [*Examples*])
#show: super-T-as-transpose // Necessary!
#grid(
columns: (auto, auto),
row-gutter: 1em,
column-gutter: 2em,
[
*(1)* #hl(`(U V_n W')^T = W'^T V_n^T U^T`) \
$ (Sigma V_n W')^T = W'^T V_n^T Sigma^T $
],
[
*(2)* #hl(`vec(a, b)^T, mat(a, b; c, d)^T`) \
$ vec(a, b)^T, mat(a, b; c, d)^T $
],
[
*(3)* #hl(`abs(a)^T, norm(a)^T, eval(F(t))^T_0`) \
$ abs(a)^T, norm(a)^T, eval(F(t))^T_0 $
],
[
*(4)* #hl(`integral^T, sum^T, product^T`) \
$ integral^T, sum^T, product^T $
],
[
*(5)* #hl(`limits(e)^T, scripts(e)^T`) \
$ limits(e)^T, scripts(e)^T $
],
[
*(6)* #hl(`(M+N)^T, (m+n)^scripts(T)`) \
$ (M+N)^T, (m+n)^scripts(T) $
]
)
=== Matrix dagger with superscript +
The conjugate transpose, also known as the Hermitian transpose, transjugate, or
adjoint, of a complex matrix $A$ is performed by first transposing and then
complex-conjugating each matrix element. It is often denoted as $A^*$,
$A^upright(sans(H))$, and sometimes with a dagger symbol:
`A^dagger` $=> A^dagger$.
Writing `..^dagger` often visually clutters an equation in the source code form.
Therefore, the package offers the ability to write `..^+` instead.
This $square.stroked.dotted^+ => square.stroked.dotted^dagger$ conversion is
disabled if the base is either
- a `limits(...)` or `scripts(...)` element, or
- an equation or `lr(...)` element whose last child is one of the above.
This feature needs to be enabled explicitly through a _show rule_.
```typ
#show: super-plus-as-dagger
U^+U = U U^+ = I
```
If you only want to enable it within a content block's scope (e.g. you want
to have $square.stroked.dotted^+$ for ions or Moore–Penrose inverse outside the
block), you may do
```typ
#[
#show: super-plus-as-dagger // Enabled from here till the end of block.
U^+U = U U^+ = I
]
```
Overrides: if you really want to
- print a dagger explicitly: use the built-in symbol `dagger` as normal: `A^dagger` $=> A^dagger$;
- print a superscript plus sign: use `scripts(+)`: `A^scripts(+)` $=> A^scripts(+)$.
#align(center, [*Examples*])
#show: super-plus-as-dagger // Necessary!
#grid(
columns: (auto, auto),
row-gutter: 1em,
column-gutter: 2em,
[
*(1)* #hl(`U^+U = U U^+ = I`) \
$ U^+U = U U^+ = I $
],
[
*(2)* #hl(`mat(1+i,1;2-i,1)^+ = mat(1-i,2+i;1,1)`) \
$ mat(1+i,1;2-i,1)^+ = mat(1-i,2+i;1,1) $
],
[
*(3)* #hl(`limits(N)^+, scripts(N)^+`) \
$ limits(N)^+, scripts(N)^+ $
],
[
*(4)* #hl(`#let eq = $scripts(N)$; eq^+`) \
$ #let eq = $scripts(N)$; eq^+ $
],
)
== Miscellaneous
#v(1em)
=== Reduced Planck constant (hbar)
#v(1em)
In the default font, the Typst built-in symbol `planck.reduce` $planck.reduce$ looks a bit off: on letter "h" there is a slash instead of a horizontal bar, contrary to the symbol's colloquial name "h-bar". This package offers `hbar` to render the symbol in the familiar form: $hbar$. Contrast:
#table(
columns: (auto, auto, auto, auto, auto),
align: horizon,
column-gutter: 1em,
stroke: none,
[Typst's `planck.reduce`],
[$ E = planck.reduce omega $],
[$ (pi G^2) / (planck.reduce c^4) $],
[$ A e^(frac(i(p x - E t), planck.reduce)) $],
[$ i planck.reduce pdv(,t) psi = -frac(planck.reduce^2, 2m) laplacian psi $],
[this package's `hbar`],
[$ E = hbar omega $],
[$ (pi G^2) / (hbar c^4) $],
[$ A e^(frac(i(p x - E t), hbar)) $],
[$ i hbar pdv(,t) psi = -frac(hbar^2, 2m) laplacian psi $],
)
*Known limitation*: `hbar` uses the `strike` function, and show rules of `strike` will affect `hbar`.
Therefore, you may have to revert your show rules for `hbar`. The following is an example.
// There hardly exists a robust fix before https://github.com/typst/typst/issues/420 is resolved.
#raw(
```typst
#import "@preview/physica:{VERSION}": hbar as old-hbar
#show strike: set text(gray)
#let hbar = {
show strike: set text(black)