[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.3 表記法

この節では,本マニュアルで使用されている表記方法について説明します。 この節は読み飛ばしてもかまいませんし,後で参照し直してもよいでしょう。


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.3.1 フォント

Octaveコードの例は,svd (a) のようなフォントまたは形式で表します。 引数や説明用の変数を表すときは,first-number のようなフォントまたは 形式で表します。 シェルのプロンプトに打ち込むコマンドは,`octave --no-init-file' のよ うなフォントまたは形式で表します。 Octaveのプロンプトに打ち込むコマンドは,foo --bar --baz のようなフォ ントまたは形式で表します。 キーボード上の特定のキーを表すには,ANY のような形式です。


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.3.2 命令結果の表記

このマニュアルの例において,あなたが命令した結果は,`⇒' で 示します。たとえば,

 
sqrt (2)
     ⇒ 1.4142

となります。 これは,「sqrt (2) は 1.4142 と計算された」と読みます。

場合によっては,条件式によって返される行列の値は,以下のように表示され ます。

 
[1, 2; 3, 4] == [1, 3; 2, 4]
     ⇒ [ 1, 0; 0, 1 ]

その他の場合には,行列は以下のように表示されます。

 
eye (3)
     ⇒  1  0  0
         0  1  0
         0  0  1

これは,結果の構造をはっきりと示すためです。

ときどき,ある表現を記述する手助けのため,同じ結果を返す別の表記を することがあります。全く等価な表現は,`≡' で示します。 たとえば,以下のようになります。

 
rot90 ([1, 2; 3, 4], -1)
≡
rot90 ([1, 2; 3, 4], 3)
≡
rot90 ([1, 2; 3, 4], 7)

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.3.3 出力の表記

このマニュアルに掲載した例の多くは,式が評価されたときに表示される文字 列を表示しています。このマニュアルにある例は,出力された文字列を `-|' で示しています。式を評価するときに返される値(以下の例 では1)は,別の行に `⇒' で表示しています。

 
printf ("foo %s\n", "bar")
     -| foo bar
     ⇒ 1

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.3.4 エラーメッセージ

中にはエラーを返す例もあります。これは,通常はエラーメッセージを端末に 表示します。エラーメッセージは,error: から始まる行で示します。

 
struct_elements ([1, 2; 3, 4])
error: struct_elements: wrong type argument `matrix'

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.3.5 解説のフォーマット

関数,コマンドおよび変数の解説は,このマニュアルでは同一の書式で記述して います。解説の最初の行は名前(関数名,コマンド名および変数名)に続いて, 必要に応じて引数が含まれます。 次の行以降に解説が続き,ときどき例も続きます。


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.3.5.1 簡単な関数の解説

関数の解説において,関数名が最初に表れます。同じ行には,引数のリストが 続いています。引数の名前は,解説中においても使用しています。

架空の関数 foo の解説例です:

Function: foo (x, y, …)

関数 foo は,y から x を減じ,その結果に残りの引数を 加算します。もし y が与えられなければ,かわりに標準状態で 19 を使 用します。

 
foo (1, [3, 5], 3, 9)
     ⇒ [ 14, 16 ]
foo (5)
     ⇒ 14

より一般には,以下のようになる。

 
foo (w, x, y, …)
≡
x - w + y + …

その名前に型の名称を含む引数(たとえばintegerinteger1ある いはmatrix)は,その型であることを期待しています。objectと 名付けた引数は,何らかの型となります。その他の種類の名前(たとえば new_file)は,関数の解説において具体的に論じています。ある節の中 には,いくつかの関数に共通な引数の機能について,解説の最初に述べていま す。

Octaveの関数は,いくつかの方式によって定義されています。関数についての カテゴリ名は,関数が定義された方法を表す名称を表しています。これら付加 的な情報は,以下のようなものです。

Built-in Function

この表記のある関数は,C++,CあるいはFortran言語で書かれていて,コンパイル 済みのOctaveバイナリの一部です。

Loadable Function

この表記のある関数は,C++,CあるいはFortran言語で書かれています。ユーザが 供給した関数のダイナミックリンクをサポートするシステムでは,Octaveを実行 している間に,必要なときにだけ自動的にリンクされます。 動的にリンクされる関数を参照してください。

Function File

この表記のある関数は,Octaveコマンドを使用して書かれていおり,テキストファ イルに保存してあります。 関数ファイルを参照してください。

Mapping Function

この表記のある関数は,引数として与えた行列およびベクトルの,各要素に対して それぞれ処理を行います。


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.3.5.2 簡単なコマンドの解説

コマンドの解説は,関数の説明と似た形式です。ただ,`関数'が`コマンド'に 置きかわっれいるだけです。コマンドとは,引数をかっこでくくらないで呼び 出す関数です。たとえば,Octaveの cd コマンドについての解説を示 します。

Command: cd dir
Command: chdir dir

現在の作業ディレクトリを dir に変更します。たとえば,cd ~/octave は,現在の作業ディレクトリを `~/octave' に移動します。もし,そのディ レクトリが存在しないならば,エラーメッセージを表示し,作業ディレクトリは 変更されません。


[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

1.3.5.3 簡単な変数の解説

変数とは,値を保持することのできる名前です。任意の変数は,ユーザに よってセットすることができますが,ユーザがOctaveの挙動を変更することがで きるようにするために,形式的に組み込み変数built-in variables) が存在します(組み込み変数は,ときどき ユーザオプションとも呼ばれ ます)。通常の変数および組み込み変数は,引数が無いことを除いて,関数と同 様の解説を行っています。

架空の組み込み変数 do_what_i_mean_not_what_i_say. についての解説例を示します。

Built-in Variable: do_what_i_mean_not_what_i_say

もしこの変数がゼロでないならば,たとえあなたが完全に間違っていて意味の ないコマンドリストを入力したとしても,Octaveはあなたが本当にやりたかっ たことを実行します。

他の変数の解説は,同様の書式をとっています。しかし,`組み込み変数'は 通常の`変数',あるいは変更されない`定数'に置き換えられます。


[ < ] [ > ]   [ << ] [ Up ] [ >> ]

This document was generated on July, 20 2006 using texi2html 1.76.