QContiguousCache Class

メンバ関数のドキュメント

[explicit] QContiguousCache::QContiguousCache(qsizetype capacity = 0)

指定されたcapacity を使用してキャッシュを構築します。

setCapacity()も参照してください 。

QContiguousCache::QContiguousCache(const QContiguousCache<T> &other)

other のコピーを作成します。

QContiguousCacheは暗黙的に共有されているため、この操作は定数時間を要します。これにより、関数からQContiguousCacheを返す処理は非常に高速になります。共有されているインスタンスが変更された場合、そのインスタンスはコピーされます（コピー・オン・ライト）が、これには線形時間がかかります。

operator=()も参照してください 。

QContiguousCache::~QContiguousCache()

キャッシュを削除します。

void QContiguousCache::append(const T &value)

キャッシュの末尾に `value ` を挿入します。キャッシュがすでに満杯の場合は、キャッシュの先頭にある項目が削除されます。

prepend()、insert()、isFull()も参照してください 。

bool QContiguousCache::areIndexesValid() const

キャッシュに格納されている項目のインデックスが有効かどうかを返します。インデックスは、インデックス位置 INT_MAX の後に項目が追加された場合、またはインデックス位置 0 の前に項目が追加された場合に無効になることがあります。これは、連続したキャッシュを非常に長期間にわたって循環バッファ方式で使用する場合にのみ発生すると予想されます。normalizeIndexes() を呼び出すことで、インデックスを再び有効にすることができます。

normalizeIndexes()、append()、およびprepend()も参照してください 。

const T &QContiguousCache::at(qsizetype i) const

キャッシュ内のインデックス位置i にある項目を返します。i は、キャッシュ内の有効なインデックス位置でなければなりません（つまり、firstIndex() <=i <=lastIndex()）。

キャッシュ内のインデックスは、その項目がキャッシュに最初に追加された項目から何番目の位置にあるかを示しています。 つまり、容量が 100 で、150 個の項目が追加されたキャッシュの場合、有効なインデックス範囲は 50 から 149 となります。これにより、理論上無限のリストに基づいて、キャッシュへの項目の挿入および取得が可能になります。

firstIndex()、lastIndex()、insert()、およびoperator[]()も参照してください 。

qsizetype QContiguousCache::available() const

キャッシュが満杯になるまでに追加できる項目の数を返します。

size()、capacity()、およびisFull()も参照してください 。

qsizetype QContiguousCache::capacity() const

キャッシュが満杯になるまでに格納できる項目の数を返します。キャッシュ内の項目数がその容量と等しくなった場合、新しい項目を追加すると、追加された項目から最も遠い項目が削除されます。

setCapacity() およびsize()も参照してください 。

void QContiguousCache::clear()

キャッシュからすべての項目を削除します。容量は変更されません。

bool QContiguousCache::containsIndex(qsizetype i) const

キャッシュのインデックス範囲に指定されたインデックスi が含まれている場合、true を返します。

firstIndex() およびlastIndex()も参照してください 。

qsizetype QContiguousCache::count() const

size() と同様です。

T &QContiguousCache::first()

キャッシュ内の最初の項目への参照を返します。この関数は、キャッシュが空ではないことを前提としています。

last() およびisEmpty()も参照してください 。

const T &QContiguousCache::first() const

qsizetype QContiguousCache::firstIndex() const

キャッシュ内の最初の有効なインデックスを返します。キャッシュが空の場合、インデックスは無効となります。

capacity()、size()、およびlastIndex()も参照してください 。

void QContiguousCache::insert(qsizetype i, const T &value)

インデックス位置i にvalue を挿入します。キャッシュにすでにi の項目が含まれている場合、その値は上書きされます。i がlastIndex() より 1 大きい、またはfirstIndex() より 1 小さい場合、これはappend() またはprepend() と同等となります。

指定されたインデックスi が、キャッシュの現在の範囲内にないか、キャッシュのインデックス範囲の境界に隣接していない場合、アイテムを挿入する前にまずキャッシュがクリアされます。この時点で、キャッシュのサイズは 1 になります。キャッシュの現在のインデックス範囲に隣接する位置から始まる順序でアイテムを挿入するよう工夫する価値があります。

QContiguousCache クラスの有効なインデックスの範囲は 0 から INT_MAX までです。この範囲外に挿入すると、未定義の挙動となります。

prepend()、append()、isFull()、firstIndex()、およびlastIndex()も参照してください 。

bool QContiguousCache::isEmpty() const

キャッシュ内にアイテムが格納されていない場合、true を返します。

size() およびcapacity()も参照してください 。

bool QContiguousCache::isFull() const

キャッシュ内に格納されている項目の数がキャッシュの容量と等しい場合、true を返します。

size() およびcapacity()も参照してください 。

T &QContiguousCache::last()

キャッシュ内の最後の項目への参照を返します。この関数は、キャッシュが空ではないことを前提としています。

first() およびisEmpty()も参照してください 。

const T &QContiguousCache::last() const

qsizetype QContiguousCache::lastIndex() const

キャッシュ内の最後の有効なインデックスを返します。キャッシュが空の場合、インデックスは無効になります。

capacity()、size()、およびfirstIndex()も参照してください 。

void QContiguousCache::normalizeIndexes()

キャッシュの先頭インデックスと末尾インデックスを、有効なインデックスを指すように移動します。この関数は、キャッシュの内容やキャッシュ内の要素の順序を変更することはありません。

この関数は、キャッシュを循環バッファとして使用する際に、インデックスのオーバーフローを修正できるようにするために提供されています。

QContiguousCache<int> cache(10);
cache.insert(INT_MAX, 1); // cache contains one value and has valid indexes, INT_MAX to INT_MAX
cache.append(2); // cache contains two values but does not have valid indexes.
cache.normalizeIndexes(); // cache has two values, 1 and 2.  New first index will be in the range of 0 to capacity().

areIndexesValid()、append()、およびprepend()も参照してください 。

void QContiguousCache::prepend(const T &value)

キャッシュの先頭に `value ` を挿入します。キャッシュがすでに満杯の場合は、キャッシュの末尾にある項目が削除されます。

append()、insert()、およびisFull()も参照してください 。

void QContiguousCache::removeFirst()

キャッシュから最初の項目を削除します。この関数は、キャッシュが空ではないことを前提としています。

removeLast()も参照してください 。

void QContiguousCache::removeLast()

キャッシュから最後の項目を削除します。この関数は、キャッシュが空ではないことを前提としています。

removeFirst()も参照してください 。

void QContiguousCache::setCapacity(qsizetype size)

キャッシュの容量を、指定されたsize に設定します。キャッシュには、その容量と同じ数のアイテムを格納できます。キャッシュにアイテムを挿入、末尾への追加、または先頭への追加を行う際、キャッシュがすでに満杯の場合は、追加されるアイテムから最も遠い位置にあるアイテムが削除されます。

指定されたsize がキャッシュ内の現在のアイテム数よりも小さい場合、キャッシュ内の最後のsize 個のアイテムのみが残ります。

capacity() およびisFull()も参照してください 。

qsizetype QContiguousCache::size() const

キャッシュ内に格納されている項目の数を返します。

capacity()も参照してください 。

[noexcept] void QContiguousCache::swap(QContiguousCache<T> &other)

このキャッシュをother と入れ替えます。この操作は非常に高速で、失敗することはありません。

T QContiguousCache::takeFirst()

キャッシュの先頭にある項目を削除し、それを返します。この関数は、キャッシュが空ではないことを前提としています。

戻り値を使用しない場合は、removeFirst() の方が効率的です。

takeLast() およびremoveFirst()も参照してください 。

T QContiguousCache::takeLast()

キャッシュの最後の項目を削除し、それを返します。この関数は、キャッシュが空ではないことを前提としています。

戻り値を使用しない場合は、removeLast() の方が効率的です。

takeFirst() およびremoveLast()も参照してください 。

bool QContiguousCache::operator!=(const QContiguousCache<T> &other) const

other がこのキャッシュと等しくない場合はtrue を返し、それ以外の場合はfalse を返します。

2つのキャッシュは、同じインデックスに同じ値が含まれている場合に等しいとみなされます。この関数を使用するには、値の型が `operator==()` を実装している必要があります。

operator==()も参照してください 。

[noexcept] QContiguousCache<T> &QContiguousCache::operator=(QContiguousCache<T> &&other)

other をこのQContiguousCache インスタンスに割り当てます。

QContiguousCache<T> &QContiguousCache::operator=(const QContiguousCache<T> &other)

このキャッシュにother を割り当て、このキャッシュへの参照を返します。

bool QContiguousCache::operator==(const QContiguousCache<T> &other) const

other がこのキャッシュと等しい場合はtrue を返し、そうでない場合はfalse を返します。

2つのキャッシュは、同じインデックスに同じ値が含まれている場合に等しいとみなされます。この関数を使用するには、値の型が `operator==()` を実装している必要があります。

operator!=()も参照してください 。

T &QContiguousCache::operator[](qsizetype i)

インデックス位置i にある項目を、変更可能な参照として返します。キャッシュに指定されたインデックス位置i の項目が含まれていない場合、まずその位置に空の項目を挿入します。

ほとんどの場合、at() またはinsert() を使用する方が望ましいです。

insert() およびat()も参照してください 。

const T &QContiguousCache::operator[](qsizetype i) const

(i) と同様です。