HN 日本語サマリー

← 一覧へ戻る
プログラミング

Mathupにおけるテンソル表記

Tensor Notation in Mathup (mathup.xyz)

12 pointsby runarberg1 コメント

要約

Mathupは、AsciiMathにインスパイアされたシンプルなマークアップ言語で記述された数式を、構造化されたMathMLに変換するライブラリです。コマンドライン、Node.jsパッケージ、またはブラウザスクリプトとして利用でき、MathJaxのような高機能なレンダリング機能は持たず、軽量かつ高速な数式変換に特化しています。これにより、開発者は複雑なMathMLタグを直接記述することなく、簡潔な記法で数式を表現できます。

全文翻訳

Mathup

インストール
npm
npm install mathup
import mathup from "mathup";
クライアント

以下のいずれかをダウンロードしてください:

…そして モジュール を含めます:

<script type="module" src="mathup.js"></script>
<link rel="stylesheet" href="mathup.css" />

…カスタム要素 を含めます:

<script type="module" src="math-up-element.js"></script>

…または スクリプト を含めます:

<script src="mathup.iife.js"></script>
<link rel="stylesheet" href="mathup.css" />
使い方
const expression = "1+1 = 2";
const options = {};  // オプション
const mathml = mathup(expression, options);

mathl.toString();
// => "<math><mrow><mn>1</mn><mo>+</mo><mn>1</mn></mrow><mo>=</mo><mn>2</mn></math>"

const mathNode = mathml.toDOM();
// => [object MathMLElement]

// 既存の <math> ノードをインプレースで更新
mathup("3-2 = 1", { bare: true }).updateDOM(mathNode);
カスタム要素
<math-up
  display="inline"
  dir="ltr"
  decimal-mark=","
  col-sep=";"
  row-sep=";;"
>
  1+1 = 2
</math-up>
コマンドライン
npm install -g mathup
mathup [options] -- <式>

# または標準入力から
echo <式> | mathup [options]
オプション(デフォルト値付き)
const options = {
  decimalMark: ".",   // -m  --decimal-mark="."
  colSep: ",",        // -c  --col-sep=","
  rowSep: ";",        // -r  --row-sep=";"
  display: "inline",  // -d  --display="inline"
  dir: "ltr",         //     --rtl
  bare: false,        // -b  --bare
};

注意: 小数点記号として,を選択した場合、,がデフォルトの列区切り文字になります。そして、;が列区切り文字の場合、新しいデフォルトの行区切り文字は;;になります。,を小数点記号と行区切り文字の両方として使用できますが、行区切り文字とそれに続く数字の間にスペースを追加するように注意する必要があります。その場合、両方を明示的に設定する必要があります。

const options = {
  decimalMark: ",",
  colSep: ",",
};

記述が速く、読みやすい

このパッケージは、mathupという単一の関数を公開しています。この関数は、AsciiMathに触発されたマークアップ言語で書かれたシンプルな数式を、構造化されたMathMLに出力します。

コマンドラインやサーバーのnodeパッケージとして、またはブラウザでスクリプトソースを含めることで使用できます。ブラウザでは、ドキュメント内の数式を解析する方法を選択できます。数式のような部分文字列をハード検索したり、$…$で囲まれたすべての式を解析したり、あるいは他の優れたツールを使用したりできます。出力の処理方法も選択できます。別のプログラムにパイプしたり、DOMに直接注入したり、コンソールにログを記録したりできます。

なぜMathJaxを使わないのか?

MathJaxは、複雑な数式をドキュメントに含めることだけが目的であれば、安全に使用できる優れたツールです。しかし、MathJaxはシンプルな式を構造化された形式に変換する以上の多くのことを行う複雑なソフトウェアであり、もしそれが目的だけなら、MathJaxは明らかに過剰です。Mathupは、MathJaxよりもはるかに高速(処理が少ないため)であることを約束します。MathJaxは式を検索し、解析し、変換し、レンダリングしますが、Mathupは解析と変換のみを行い、レンダリングはブラウザに任せます。

なぜAsciiMathなのか / なぜTeXを使わないのか?

私はこのツールを作成しました。なぜなら、オーバーヘッドなしで数式を素早く記述できるようにしたかったからです(例えば、\frac{1}{2}の代わりに1/2を想像してください)。TeXの式は、特にバックスラッシュ、波括弧、閉じ括弧のキーへのアクセスが複雑なキーボードでは、冗長で記述が面倒になることがあります。しかし、このパッケージの目的は、人々がMathMLを非冗長な方法で完全に制御できるようにすることではありません。目的は、人々がシンプルな式を簡単に書けるようにすることです。もちろん、記述方法において可能な限り多くの表現力を与えようとしますが、すべての複雑なことを可能にすることを約束するわけではありません。

MathMLの完全なサポートが必要で、タグをすべて記述したくない場合は、別のツールを探すことをお勧めします。TeX形式でMathMLを記述できるようにする素晴らしい取り組みが他にもあります。TeXZillaなどを参照してください。

リファレンス

基本

Mathupは、MathMLの4つのトークン要素(識別子 <mi>、演算子 <mo>、数値 <mn>、テキスト <mtext>)を使用します。Mathupは、シンプルな式を書いたときに、これらのどれを意味するかを認識します。

例えば、1+1 = 2 ⇒

<mrow>
  <mn>1</mn>
  <mo>+</mo>
  <mn>1</mn>
</mrow>
<mo>=</mo>
<mn>2</mn>

そして sin theta ⇒

<mi>sin</mi><mi>θ</mi>

Mathupは、あなたが書くほとんどのUnicode文字も認識します。文字が数学的演算子のコードブロックのいずれかから来た場合、それは <mo> タグで囲まれ、それ以外の場合は <mi> タグで囲まれます。さらに、dが微分の一部であることが明らかな場合、それは <mo> タグで囲まれます。

数値

数値は通常、あなたが考える通りのものです(Ⅻや↋のようなUnicode数字を含む)。しかし、奇妙な方法で数値を書きたい場合(例えば、単語で綴る、16進数文字列、またはローマ数字で)、#で始まる文字列を前置できます(例: #0x2A)。または、数値に英数字以外の文字が含まれる場合は、バッククォートで囲まれたフェンス(Markdownのように)を使用します。#`…`例えば#`forty two`または ``` # 42 ```のようにして 42 ``を数値にします。

演算子

Pc、Pd、Pe、Pf、Pi、Po、Ps、Sm、またはSoのUnicodeカテゴリにあるものはすべて演算子と見なされます。さらに、バックスラッシュ \ の直後に続くシンボル文字または英数字文字列は演算子(<mo>)になります。複数のシンボル文字、または複数の単語を単一の演算子として使用する必要がある場合(例: <mo>for each</mo>)、Markdownのセマンティクスに従ってフェンスで囲むことができます(例: \`for each` または \`` ` `` で <mo>`</mo>)。

以下は、対応する演算子にマッピングされます。

操作関連
.$

FUNCTION APPLICATION(ゼロ幅)

.*

INVISIBLE TIMES(ゼロ幅)

.+

INVISIBLE PLUS(ゼロ幅)

lim

lim

mod

mod

-

−

+-

±

-+

∓

*

·

xx

×

-:

÷

//

⁄

prod

∏

sum

∑

**

∗

@

∘

^^

∧

vv

∨

nn

∩

uu

∪

int

∫

dint

∬

oint

∮

!=

≠

!==

≢

o+

⊕

ox

⊗

o.

⊙

^^^

⋀

vvv

⋁

nnn

⋂

uuu

⋃

***

⋆

|><|

⋈

|><

⋉

><|

⋊

その他
'

′

''

″

'''

‴

''''

⁗

aleph

ℵ

del

∂

grad

∇

oc, prop

∝

/_

∠

/_

△

||

∥

~=

≅

~~

≈

sub

⊂

sup

⊃

sube

⊆

supe

⊇

<>, diamond

⋄

[], square

□

<|

⊲

|>

⊳

関係演算子
in

∈

!in

∉

-=、==

≡

<=

≤

>=

≥

-<

≺

>-

≻

-<=

⪯

>-=

⪰

<<<

≪

>>>

≫

論理演算子
and

and

if

if

or

or

otherwise

otherwise

not

¬

AA

∀

EE

∃

|--

⊢

TT

⊤

_|_

⊥

|==

⊨

矢印
<-, larr

←

uarr

↑

->, rarr

→

darr

↓

harr

↔

->>

↠

>->

↣

|->

↦

lArr

⇐

=>, rArr

⇒

<=>, iff, hArr

⇔

>->>

⤖

句読点
.,

INVISIBLE SEPARATOR(ゼロ幅)

...

…

:.

∴

vdots

⋮

cdots

⋯

ddots

⋱

識別子

数値、演算子、またはテキストではないものはすべて識別子と見なされます。これには、ラテン文字、ギリシャ文字、アラビア文字(A、π、ح)や絵文字も含まれます。文字が以下の表の単語や上記の演算子表を綴る場合を除き、各文字は個別の識別子と見なされます。

文字のシーケンスを単一の識別子として強制するには、フェンスで囲みます(例: `Gamma` は <mi>Gamma</mi> を生成し、`` f` `` は <mi>f`</mi> を生成します)。

以下も単一の識別子を生成します:

標準関数
cos

cos

cosh

cosh

cot

cot

csc

csc

cosec

cosec

det

det

dim

dim

gcd

gcd

lcm

lcm

ln

ln

log

log

max

max

min

min

mod

mod

sec

sec

sin

sin

sinh

sinh

tan

tan

tanh

tanh

ギリシャ文字
Delta

Δ

Gamma

Γ

Lambda

Λ

Omega

Ω

Phi

Φ

Pi

Π

Psi

Ψ

Sigma

Σ

Theta

Θ

Xi

Ξ

alpha

α

beta

β

chi

χ

epsilon

ɛ

eta

η

gamma

γ

kappa

κ

lambda

λ

mu

μ

nu

ν

omega

ω

phi

φ

phiv

ϕ

pi

π

psi

ψ

rho

ρ

sigma

σ

tau

τ

theta

θ

upsilon

υ

xi

ξ

zeta

ζ

追加識別子
oo

∞

O/

∅

CC

ℂ

NN

ℕ

QQ

ℚ

RR

ℝ

ZZ

ℤ

テキスト

ダブルクォート("some text")で囲むと、テキストとして表示されます。テキスト注釈に引用符が含まれている場合は、さらに多くの引用符で囲むことができます(Markdownのバッククォートフェンスのように)。つまり、"" "text string" "" は <mtext>"text string"</mtext> を生成します。

スペース

MathMLには <mspace> という要素があります。2つ以上の連続するスペースは、意味のある箇所でその要素に変換されます。スペースの幅は次のようになります。

"width" = { 0.35(n - 1),, n = 2 または 3 の場合
0.5(n - 1),, n = 4 または 5 の場合
n - 3,, n > 5 の場合

ここで、n は連続するスペースの数で、width は ex 単位です。ex はフォントの ‘x’ 文字の高さです。

さらに、(mod p) は開括弧の左側に 1.65 ex のスペースを追加します。

分数

MathMLでは、分数は <mfrac> 要素で囲みます。Mathupでは、単純に分子 a と分母 b をスラッシュ(a/b)で区切ります。

Mathupは、サブ式の周りのスペースを見て、分子と分母が何を意味するかを賢く判断しようとします。そのため、a+b / c+d は a + b/c + d とは異なります。一般的に、サブ式とスラッシュの間のスペースはサブ式全体に適用され、スペースがない場合は直前または直後のものにのみ適用されます。

下付き文字と上付き文字

アンダースコアは、後続の式を下付き文字として先行する式に適用します(a_i ⇒ ai )。アスキーキャレットは上付き文字を適用します(a^2 ⇒ a2 )。そして、(式、アンダースコア、キャレット)/(式、キャレット、アンダースコア)のシーケンス(a_i^2/a^2_i)は、最初の式に下付き文字と上付き文字を適用して、ai 2 を生成します。

オーバーおよびアンダースクリプトは同様のパターンに従いますが、アンダースクリプトには ._、オーバースクリプトには .^ を使用します。また、lim_x は x をアンダースクリプトに配置し、sum_a^b および prod_a^b は a と b をアンダーおよびオーバースクリプトに配置します。

分数とは異なり、下付き/上付き文字およびアンダー/オーバー文字は右結合性を持ち、分数よりも優先されます。分数の場合と同様に、下付き/上付き文字またはアンダー/オーバー文字と周囲のサブ式の間に空白を戦略的に配置できます。例えば、e^ -1/2 は e − 1 2 を生成しますが、e^ -1 / 2 は e −1 2 を生成します。

括弧で囲まれたグループ

括弧を使用して項をグループ化できます。任意のUnicodeの開き括弧(Unicodeカテゴリ Ps)はフェンスを開始し、任意の閉じ括弧(カテゴリ Pe)はそれを閉じます。括弧は一致する必要はありませんが、開閉のペアである必要があります。

フェンスなしのグループは {: と :} で示します。グループの内容を任意の演算子で囲むことができます。それらは新しいフェンスになります。例えば、グループを閉じるために開き括弧が必要な場合は、それらを演算子にキャストし、次のように手動でグループをフェンスで囲むことができます。

]{: a, b :}[ ⇒ ] a,b [

最後に、グループ内では、,のような通常の区切り文字に加えて、特別な :|: をグループ区切り文字として使用できます。これはブラ-ケット記法を記述するのに特に便利です。

(: Phi :|: Psi :) ⇒ ⟨Φ|Ψ⟩。

追加のフェンス
{:a, b:}

a , b

(:a:|:b:)

⟨ a | b ⟩

<<a, b>>

⟨ a , b ⟩

|(a, b)|

| a , b |

|:a, b:|

| a , b |

||(a, b)||

∥ a , b ∥

||:a, b:||

∥ a , b ∥

|~x~|

⌈ x ⌉

|__x__|

⌊ x ⌋

追加のフェンスショートカット
binom(a, b)

( a b )

abs x

| x |

norm x

∥ x ∥

ceil x

⌈ x ⌉

floor x

⌊ x ⌋

行列

行列は、少なくとも1つの行区切り文字(;)を持つフェンスで囲まれたグループです。例えば、A = [1,2,3; 4,5,6] は2×3行列であり、[1,4; 2,5; 3,6] は A T です。末尾の行区切りも許可されているため、単一行の行列を [1,2,3;] のように記述できます。改行文字も行区切り文字として使用できます。

これらはすべて、外側の括弧を表のフェンスとして囲むだけです。したがって、ケース代入を記述したい場合は、次のように記述できます。

|x| = { x, if x >= 0 ; -x, otherwise :}
テンソルとインデックス

テンソルやその他の複雑なインデックスを記述するには、ハット ^ またはアンダースコア _ 文字でグループを開始できます。後続の式は、最初の上または下インデックスになります。後続の ^ または _ は、新しいインデックスを開始します(A(^b_c) は A cb となります)。インデックスを新しい列に追加するには、^ または _ の前に , を追加します:A(^b,_c) は A b c となります。, の後に ^ または _ を省略すると、前のインデックス位置を繰り返すことができます:A(_b,c,d,^e,f,g) は A b c d e f g となります。

また、式を直接続けることで、プリスクリプトを追加できます。[^14_6]rm C は C 614 となり、両方の場合 (^n)P(_k) は P k n となります。プリスクリプトが優先されます。

インデックスに下付き文字または上付き文字を追加したい場合は、インデックス全体を括弧で囲みます(A(^(a_i),...,(a_n)) ⇒ A ai … an )。カンマまたは括弧をインデックスとして使用したい場合は、バックスラッシュ \ でエスケープできます(A(_beta, \,, \[, a) は A β, [a となります)。

根号

MathMLには根号用の <msqrt> および <mroot> タグがあります。Mathupは同様に、x の平方根および x の n 乗根に対して sqrt x および root n x(または好みに応じて root(n, x))を提供します。

アクセント記号

以下のコマンドは、後続の式の上下にアクセント記号を追加したり、その他の種類のハイライトを追加したりします。

アクセント記号
hat a

a^

bar a

a‾

vec a

a→

dot a

a⋅

ddot a

a⋅⋅

tilde a

a˜

ul a

a

oparen a+b

a+b ⏜

uparen a+b

a+b ⏝

obrace a+b

a+b ⏞

ubrace a+b

a+b ⏟

obracket a+b

a+b ⎴

ubracket a+b

a+b ⎵

oshell a+b

a+b ⏠

ushell a+b

a+b ⏡

cancel a+b

a+b

フォントコマンド

任意の式にフォントコマンドを前置できます。すると、その式内のすべてのトークン要素は以下のバリアントを持ちます。一部のバリアントは組み合わせ可能で、順序は関係ありません。

太字(bf)、イタリック(it)、サンセリフ(sf)、モノスペース(tt)は、テキスト(bf tt "text")に対してCSSを使用して設定されます。サンセリフおよびモノスペーステキストのフォントファミリーを制御したい場合は、それぞれ --mathup-font-family-sans-serif および --mathup-font-family-monospace のCSSカスタムプロパティを設定できます。

フォントコマンド
rm

ノーマル

bf

太字

it

イタリック

bf it

太字イタリック

bb

𝕕𝕠𝕦𝕓𝕝𝕖-𝕤𝕥𝕣𝕦𝕔𝕜

cc

𝓈𝒸𝓇𝒾𝓅𝓉

bf cc

𝓼𝓬𝓻𝓲𝓹𝓽

fr

𝔣𝔯𝔞𝔠𝔱𝔲𝔯

bf fr

𝖋𝖗𝖆𝖈𝖙𝖚𝖗

sf

𝗌𝖺𝗇𝗌-𝗌𝖾𝗋𝗂𝖿

bf sf

𝘀𝗮𝗻𝘀-𝘀𝗲𝗿𝗶𝗳

it sf

𝘴𝘢𝘯𝘴-𝘴𝘦𝘳𝘪𝘧

bf it sf

𝙨𝙖𝙣𝙨-𝙨𝙚𝙧𝙞𝙛

tt

𝚖𝚘𝚗𝚘𝚜𝚙𝚊𝚌𝚎

色

式の特定の部分の色または背景色を、その色を入力するだけで変更できます。背景は bg.<色名> で前置されます。その色のバリアントが気に入らない場合は、--mathup-color-<色名> または --mathup-background-<色名> のCSSカスタムプロパティを使用して上書きできます。例えば:

絵文字キーボードがある場合、色のために色付き円の絵文字(🔴🟠🟡🟢🔵🟣🟤)を、背景のために色付き四角形の絵文字(🟥🟧🟨🟩🟦🟪🟫)を使用できます。黒と白の円はミディアムバリアント(⚫⚪)を、黒と白の四角形はラージバリアント(⬛⬜)を使用します。

:root {
  --mathup-color-red: lch(50% 130 20);
  --mathup-background-green: lch(50% 132 180);
}

利用可能な色は以下を参照してください。

色
red, 🔴

赤

orange, 🟠

オレンジ

yellow, 🟡

黄色

green, 🟢

緑

cyan

シアン

blue, 🔵

青

purple, 🟣

紫

brown, 🟤

茶色

black, ⚫

黒

gray

灰色

lightgray

ライトグレー

white, ⚪

白

背景色
bg.red, 🟥

赤

bg.orange, 🟧

オレンジ

bg.yellow, 🟨

黄色

bg.green, 🟩

緑

bg.cyan

シアン

bg.blue, 🟦

青

bg.purple, 🟪

紫

brown, 🟫

茶色

bg.black, ⬛

黒

bg.gray

灰色

bg.lightgray

ライトグレー

bg.white, ⬜

白