Libx xxHash

    このページの内容

    データ構造

    struct  XXH64_canonical_t
     次の型の正規（ビッグエンディアン）表現： XXH64_hash_t。 詳細…

    型定義

    typedef struct XXH64_state_s XXH64_state_t
     XXH64ストリーミングAPIの不透明な状態構造体。

    関数

    XXH64_hash_t XXH64 (const void *input, size_t length, XXH64_hash_t seed)
     inputの64ビットハッシュをxxHash64で計算します。
    XXH64_state_t * XXH64_createState (void)
     XXH64_state_tを割り当てます。
    XXH_errorcode XXH64_freeState (XXH64_state_t *statePtr)
     XXH64_state_tを解放します。
    void XXH64_copyState (XXH64_state_t *dst_state, const XXH64_state_t *src_state)
     XXH64_state_tの状態を別の状態にコピーします。
    XXH_errorcode XXH64_reset (XXH64_state_t *statePtr, XXH64_hash_t seed)
     新しいハッシュの計算を開始するため、XXH64_state_tをリセットします。
    XXH_errorcode XXH64_update (XXH64_state_t *statePtr, const void *input, size_t length)
     inputのブロックを取り込み、XXH64_state_tに反映します。
    XXH64_hash_t XXH64_digest (const XXH64_state_t *statePtr)
     XXH64_state_tから計算したハッシュ値を返します。
    void XXH64_canonicalFromHash (XXH64_canonical_t *dst, XXH64_hash_t hash)
     XXH64_hash_tを、ビッグエンディアンのXXH64_canonical_tに変換します。
    XXH64_hash_t XXH64_hashFromCanonical (const XXH64_canonical_t *src)
     XXH64_canonical_tを、ネイティブ形式のXXH64_hash_tに変換します。

    詳細説明

    従来の64ビットxxHashアルゴリズムで使用する関数を含みます。

    注記
    XXH3は32ビットと64ビットの両システムで競争力のある速度を備え、実際の64/128ビットのハッシュ結果を提供します。ベクトル処理に対応するシステムでは、より高速に動作します。

    型定義の説明

    ◆ XXH64_state_t

    typedef struct XXH64_state_s XXH64_state_t

    XXH64ストリーミングAPIの不透明な状態構造体。

    関連項目
    XXH64_state_s に詳細があります。
    ストリーミングの例

    関数の説明

    ◆ XXH64()

    XXH64_hash_t XXH64 ( const void * input,
    size_t length,
    XXH64_hash_t seed )

    inputの64ビットハッシュをxxHash64で計算します。

    引数
    inputハッシュを計算するデータブロック。サイズは少なくとも length バイト必要です。
    length次のデータの長さ： input（バイト単位）。
    seedハッシュの出力を予測可能な形で変化させる64ビットのシード。
    前提条件
    inputからinput + lengthまでの範囲のメモリは有効で、読み取り可能な連続したメモリでなければなりません。ただし、 length が 0 の場合、inputは NULL でも構いません。C++では、これはさらに次の要件を満たす必要があります： TriviallyCopyable。
    戻り値
    計算された64ビットのxxHash64値。
    関連項目
    一括処理の例 に使用例があります。

    ◆ XXH64_createState()

    XXH64_state_t * XXH64_createState ( void )

    XXH64_state_tを割り当てます。

    戻り値
    割り当てられた次の型のポインター： XXH64_state_t （成功した場合）。
    NULL （失敗した場合）。
    注記
    解放には必ず次の関数を使用してください： XXH64_freeState()。
    関連項目
    ストリーミングの例

    ◆ XXH64_freeState()

    XXH_errorcode XXH64_freeState ( XXH64_state_t * statePtr)

    XXH64_state_tを解放します。

    引数
    statePtr次の型のポインター： XXH64_state_t 。割り当てには次の関数を使用してください： XXH64_createState()。
    戻り値
    XXH_OK。
    注記
    statePtr は、次の関数で割り当てたものでなければなりません： XXH64_createState()。
    関連項目
    ストリーミングの例

    ◆ XXH64_copyState()

    void XXH64_copyState ( XXH64_state_t * dst_state,
    const XXH64_state_t * src_state )

    XXH64_state_tの状態を別の状態にコピーします。

    引数
    dst_stateコピー先の状態。
    src_stateコピー元の状態。
    前提条件
    dst_state と src_state は NULL であってはならず、互いに重なっていてもいけません。

    ◆ XXH64_reset()

    XXH_errorcode XXH64_reset ( XXH64_state_t * statePtr,
    XXH64_hash_t seed )

    新しいハッシュの計算を開始するため、XXH64_state_tをリセットします。

    引数
    statePtrリセットする状態構造体。
    seedハッシュ結果を予測可能な形で変化させる64ビットのシード。
    前提条件
    statePtr は NULL であってはなりません。
    戻り値
    XXH_OK （成功した場合）。
    XXH_ERROR （失敗した場合）。
    注記
    この関数は状態をリセットしてシードを設定します。次の関数より前に呼び出してください： XXH64_update()。
    関連項目
    ストリーミングの例

    ◆ XXH64_update()

    XXH_errorcode XXH64_update ( XXH64_state_t * statePtr,
    const void * input,
    size_t length )

    inputのブロックを取り込み、XXH64_state_tに反映します。

    引数
    statePtr更新する状態構造体。
    inputハッシュを計算するデータブロック。サイズは少なくとも length バイト必要です。
    length次のデータの長さ： input（バイト単位）。
    前提条件
    statePtr は NULL であってはなりません。
    inputからinput + lengthまでの範囲のメモリは有効で、読み取り可能な連続したメモリでなければなりません。ただし、 length が 0 の場合、inputは NULL でも構いません。C++では、これはさらに次の要件を満たす必要があります： TriviallyCopyable。
    戻り値
    XXH_OK （成功した場合）。
    XXH_ERROR （失敗した場合）。
    注記
    データブロックを逐次取り込むには、この関数を呼び出してください。
    関連項目
    ストリーミングの例

    ◆ XXH64_digest()

    XXH64_hash_t XXH64_digest ( const XXH64_state_t * statePtr)

    XXH64_state_tから計算したハッシュ値を返します。

    引数
    statePtrハッシュの計算元となる状態構造体。
    前提条件
    statePtr は NULL であってはなりません。
    戻り値
    その状態から計算された64ビットのxxHash64値。
    注記
    次の関数を呼び出しても： XXH64_digest() 次の状態には影響しません： statePtr。そのため、更新、ダイジェストの取得、再度の更新という操作ができます。
    関連項目
    ストリーミングの例

    ◆ XXH64_canonicalFromHash()

    void XXH64_canonicalFromHash ( XXH64_canonical_t * dst,
    XXH64_hash_t hash )

    XXH64_hash_tを、ビッグエンディアンのXXH64_canonical_tに変換します。

    引数
    dst次の型： XXH64_canonical_t 。保存先のポインター。
    hash次の型： XXH64_hash_t 。変換元のハッシュ。
    前提条件
    dst は NULL であってはなりません。
    関連項目
    正規形式の例

    ◆ XXH64_hashFromCanonical()

    XXH64_hash_t XXH64_hashFromCanonical ( const XXH64_canonical_t * src)

    XXH64_canonical_tを、ネイティブ形式のXXH64_hash_tに変換します。

    引数
    src次の型： XXH64_canonical_t 。変換元の正規形式の値。
    前提条件
    src は NULL であってはなりません。
    戻り値
    変換されたハッシュ。
    関連項目
    正規形式の例