表記規則

このドキュメントでは、以下の表記を使用しています。

表記

説明

斜体

新しい用語、用語の意味、プレースホルダー、マニュアルのタイトルを示します。

ファイル名は本体拡張子 からなります。

詳細は、「インテルのリンカーマニュアル」を参照してください。

モノスペース

本文テキストのディレクトリー・パスとファイル名、コマンドとコマンドライン・オプション、関数名、メソッド、クラス、データ構造、およびソースコードを示します。

ippsapi.h

\alt\include

okCreateObjs() 関数を使用して...

printf("hello, world\n");

モノスペース斜体

ソースコードのプレースホルダーを示します。

blocked_range<Type>

モノスペース太字

ソースコードの一部を強調します。

x = ( h > 0 ? sizeof(m) : 0xF ) + min;

[ ]

括弧で囲まれた項目はオプションです。

Fa[c]

Fa または Fac を示します。

{ | }

波括弧および垂直線は複数の項目から 1 つの項目を選択することを示します。

X{K | W | P}

XKXW、または XP を示します。

"[" "]" "{"
" }" "|"

引用符で囲まれたメタ文字は、上記で示された構文的な意味を否定します。文字はリテラルとして扱われます。

"[" X "]" [ Y ]

角括弧で囲まれた文字 X に続いて、オプションで文字 Y を指定することを示します。

...

省略記号は、前の項目を複数回指定できることを示します。

ファイル名 ...

1 つ以上のファイル名を指定することを示します。

,...

カンマに続く省略記号は、前の項目をカンマで区切って複数回指定できることを示します。

単語 ,...

1 つ以上の単語を指定することを示します。2 つ以上の単語を指定する場合は、単語をカンマで区切ります。

クラスメンバーは、どのように実際に実装されるかではなく、クライアントに見えるようにクラスを記述する略式クラス宣言によって要約されます。例えば、これはクラス Foo の略式宣言です。

class Foo {
public:
	int x();
	int y;
	~Foo();
};

実際の実装は次のようになります。

namespace internal {
	class FooBase  {
	protected:
		int x();
	};

	class Foo_v3: protected FooBase {
	private:
		int internal_stuff;
	public:
		using FooBase::x;
		int y;
	};
}

typedef internal::Foo_v3 Foo;

このサンプルは、実際の実装と略式宣言で異なる 2 つのケースを示しています。

略式宣言は、実装とは特に関係ない部分を気にすることなくクラスを使用するために、何を知っておく必要があるかを示すためのものです。