CArray.h

[詳解]

//=============================================================================
/// @file
/// 配列クラスヘッダファイル
///
/// 配列クラスヘッダファイルです。
///
/// $Id: CArray.h 245 2019-03-20 15:03:41Z admin $
/// $Date: 2019-03-21 00:03:41 +0900 (2019/03/21 (木)) $
/// $Author: admin $
///
/// @attention なし

#pragma once
#pragma managed( push, off )

//=============================================================================
// インクルードファイル
#include <LibCommonDef.h>
#include <initializer_list>

//=============================================================================
// 共通ライブラリ名前空間
namespace LibCommon {
    //=========================================================================
    /// 配列クラス
    ///
    /// 配列クラスです。
    ///
    /// @tparam    Type 配列要素型
    /// @attention テンプレートクラスです。
    ///
    template< typename Type >
    class CArray {
        //=====================================================================
        // 構築子と解体子
    public:
        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        explicit CArray() noexcept;

        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param[in] rElement 配列要素参照
        /// @return    なし
        /// @attention なし
        ///
        explicit CArray( Type const& rElement ) noexcept;

        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param[in] pBuffer バッファポインタ
        /// @param[in] nCount  配列要素数
        /// @return    なし
        /// @attention なし
        ///
        explicit CArray( Type const* pBuffer, int nCount ) noexcept;

        //---------------------------------------------------------------------
        /// コンストラクタ
        ///
        /// コンストラクタです。
        ///
        /// @param[in] rcInitializer 配列要素初期化子リスト参照
        /// @return    なし
        /// @attention なし
        ///
        explicit CArray( std::initializer_list< Type const > const& rcInitializer ) noexcept;

        //---------------------------------------------------------------------
        /// コピーコンストラクタ
        ///
        /// コピーコンストラクタです。
        ///
        /// @param[in] rcInstance インスタンス参照
        /// @return    なし
        /// @attention なし
        ///
        explicit CArray( CArray const& rcInstance ) noexcept;

        //---------------------------------------------------------------------
        /// ムーブコンストラクタ
        ///
        /// ムーブコンストラクタです。
        ///
        /// @param[in] rcInstance インスタンス左辺値参照
        /// @return    なし
        /// @attention なし
        ///
        explicit CArray( CArray&& rcInstance ) noexcept;

        //---------------------------------------------------------------------
        /// デストラクタ
        ///
        /// デストラクタです。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        virtual ~CArray() noexcept;

        //=====================================================================
        // インライン公開関数
    public:
        //---------------------------------------------------------------------
        /// 配列要素バッファ取得関数
        ///
        /// 配列要素バッファ取得関数です。
        ///
        /// @param     なし
        /// @return    バッファポインタ
        /// @attention なし
        ///
        inline virtual Type* GetBuffer() noexcept { return m_pBuffer; }

        //---------------------------------------------------------------------
        /// バッファサイズ取得関数
        ///
        /// バッファサイズ取得関数です。
        ///
        /// @param     なし
        /// @return    バッファサイズ
        /// @attention なし
        ///
        inline virtual int GetSize() const noexcept { return m_nSize; }

        //---------------------------------------------------------------------
        /// 配列要素数取得関数
        ///
        /// 配列要素数取得関数です。
        ///
        /// @param     なし
        /// @return    配列要素数
        /// @attention なし
        ///
        inline virtual int GetCount() const noexcept { return m_nCount; }

        //---------------------------------------------------------------------
        /// セグメントサイズ取得関数
        ///
        /// セグメントサイズ取得関数です。
        ///
        /// @param     なし
        /// @return    セグメントサイズ
        /// @attention なし
        ///
        inline virtual int GetSegmentSize() const noexcept { return SEGMENT_SIZE; }

        //=====================================================================
        // 公開演算子オーバーロード関数
    public:
        //---------------------------------------------------------------------
        /// コピー代入演算子オーバーロード関数
        ///
        /// コピー代入演算子オーバーロード関数です。
        ///
        /// @param[in] rcInstance インスタンス参照
        /// @return    インスタンス参照
        /// @attention なし
        ///
        virtual CArray& operator=( CArray const& rcInstance ) noexcept;

        //---------------------------------------------------------------------
        /// ムーブ代入演算子オーバーロード関数
        ///
        /// ムーブ代入演算子オーバーロード関数です。
        ///
        /// @param[in] rcInstance インスタンス左辺値参照
        /// @return    インスタンス参照
        /// @attention なし
        ///
        virtual CArray& operator=( CArray&& rcInstance ) noexcept;

        //---------------------------------------------------------------------
        /// 代入演算子オーバーロード関数
        ///
        /// 代入演算子オーバーロード関数です。
        ///
        /// @param[in] rElement 配列要素参照
        /// @return    インスタンス参照
        /// @attention なし
        ///
        virtual CArray& operator=( Type const& rElement ) noexcept;

        //---------------------------------------------------------------------
        /// 代入演算子オーバーロード関数
        ///
        /// 代入演算子オーバーロード関数です。
        ///
        /// @param[in] rcInitializer 配列要素初期化子リスト参照
        /// @attention なし
        ///
        virtual CArray& operator=( std::initializer_list< Type const > const& rcInitializer ) noexcept;

        //---------------------------------------------------------------------
        /// 加算代入演算子オーバーロード関数
        ///
        /// 加算代入演算子オーバーロード関数です。
        ///
        /// @param[in] rcInstance インスタンス参照
        /// @return    インスタンス参照
        /// @attention なし
        ///
        virtual CArray& operator+=( CArray const& rcInstance ) noexcept;

        //---------------------------------------------------------------------
        /// 加算代入演算子オーバーロード関数
        ///
        /// 加算代入演算子オーバーロード関数です。
        ///
        /// @param[in] rElement 配列要素参照
        /// @return    インスタンス参照
        /// @attention なし
        ///
        virtual CArray& operator+=( Type const& rElement ) noexcept;

        //---------------------------------------------------------------------
        /// 加算代入演算子オーバーロード関数
        ///
        /// 加算代入演算子オーバーロード関数です。
        ///
        /// @param[in] rcInitializer 配列要素初期化子リスト参照
        /// @return    インスタンス参照
        /// @attention なし
        ///
        virtual CArray& operator+=( std::initializer_list< Type const > const& rcInitializer ) noexcept;

        //---------------------------------------------------------------------
        /// 配列添字演算子オーバーロード関数
        ///
        /// 配列添字演算子オーバーロード関数です。
        ///
        /// @param[in] nIndex インデックス
        /// @return    配列要素参照
        /// @attention なし
        ///
        virtual Type& operator[]( int nIndex ) noexcept;

        //---------------------------------------------------------------------
        /// 配列要素ポインタキャスト演算子オーバーロード関数
        ///
        /// 配列要素ポインタキャスト演算子オーバーロード関数です。
        ///
        /// @param     なし
        /// @return    配列要素ポインタ
        /// @attention なし
        ///
        virtual operator Type const*() noexcept { return m_pBuffer; }

        //---------------------------------------------------------------------
        /// 関数演算子オーバーロード関数
        ///
        /// 関数演算子オーバーロード関数です。
        ///
        /// @param     なし
        /// @return    インスタンス参照
        /// @attention なし
        ///
        virtual CArray& operator()() noexcept { return *this; }

        //=====================================================================
        // 公開関数
    public:
        //---------------------------------------------------------------------
        /// クリア関数
        ///
        /// クリア関数です。
        ///
        /// @param     なし
        /// @return    なし
        /// @attention なし
        ///
        virtual void Clear() noexcept;

        //---------------------------------------------------------------------
        /// バッファ作成関数
        ///
        /// バッファ作成関数です。
        ///
        /// @param[in] nSize バッファサイズ
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool CreateBuffer( int nSize ) noexcept;

        //---------------------------------------------------------------------
        /// バッファサイズ更新関数
        ///
        /// バッファサイズ更新関数です。
        ///
        /// @param[in] nCount 配列要素数
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool UpdateBuffer( int nCount ) noexcept;

        //---------------------------------------------------------------------
        /// バッファサイズコンパクト化関数
        ///
        /// バッファサイズコンパクト化関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool CompactBuffer() noexcept;

        //---------------------------------------------------------------------
        /// コピー関数
        ///
        /// コピー関数です。
        ///
        /// @param[in] rcInstance インスタンス参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Copy( CArray const& rcInstance ) noexcept;

        //---------------------------------------------------------------------
        /// コピー関数
        ///
        /// コピー関数です。
        ///
        /// @param[in] rElement 配列要素参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Copy( Type const& rElement ) noexcept;

        //---------------------------------------------------------------------
        /// コピー関数
        ///
        /// コピー関数です。
        ///
        /// @param[in] pBuffer バッファポインタ
        /// @param[in] nCount  配列要素数
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Copy( Type const* pBuffer, int nCount ) noexcept;

        //---------------------------------------------------------------------
        /// コピー関数
        ///
        /// コピー関数です。
        ///
        /// @param[in] rcInitializer 配列要素初期化子リスト参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Copy( std::initializer_list< Type const > const& rcInitializer ) noexcept;

        //---------------------------------------------------------------------
        /// ムーブ関数
        ///
        /// ムーブ関数です。
        ///
        /// @param[in] rcInstance インスタンス左辺値参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Move( CArray&& rcInstance ) noexcept;

        //---------------------------------------------------------------------
        /// 追加関数
        ///
        /// 追加関数です。
        ///
        /// @param[in] rcInstance インスタンス参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Append( CArray const& rcInstance ) noexcept;

        //---------------------------------------------------------------------
        /// 追加関数
        ///
        /// 追加関数です。
        ///
        /// @param[in] rElement 配列要素参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Append( Type const& rElement ) noexcept;

        //---------------------------------------------------------------------
        /// 追加関数
        ///
        /// 追加関数です。
        ///
        /// @param[in] pBuffer バッファポインタ
        /// @param[in] nCount  配列要素数
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Append( Type const* pBuffer, int nCount ) noexcept;

        //---------------------------------------------------------------------
        /// 追加関数
        ///
        /// 追加関数です。
        ///
        /// @param[in] rcInitializer 配列要素初期化子リスト参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Append( std::initializer_list< Type const > const& rcInitializer ) noexcept;

        //---------------------------------------------------------------------
        /// 挿入関数
        ///
        /// 挿入関数です。
        ///
        /// @param[in] nIndex     インデックス
        /// @param[in] rcInstance インスタンス参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Insert( int nIndex, CArray const& rcInstance ) noexcept;

        //---------------------------------------------------------------------
        /// 挿入関数
        ///
        /// 挿入関数です。
        ///
        /// @param[in] nIndex   インデックス
        /// @param[in] rElement 配列要素参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Insert( int nIndex, Type const& rElement ) noexcept;

        //---------------------------------------------------------------------
        /// 挿入関数
        ///
        /// 挿入関数です。
        ///
        /// @param[in] nIndex  インデックス
        /// @param[in] pBuffer バッファポインタ
        /// @param[in] nCount  配列要素数
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Insert( int nIndex, Type const* pBuffer, int nCount ) noexcept;

        //---------------------------------------------------------------------
        /// 挿入関数
        ///
        /// 挿入関数です。
        ///
        /// @param[in] nIndex        インデックス
        /// @param[in] rcInitializer 配列要素初期化子リスト参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Insert( int nIndex, std::initializer_list< Type const > const& rcInitializer ) noexcept;

        //---------------------------------------------------------------------
        /// 削除関数
        ///
        /// 削除関数です。
        ///
        /// @param     なし
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Remove() noexcept;

        //---------------------------------------------------------------------
        /// 削除関数
        ///
        /// 削除関数です。
        ///
        /// @param[in] nIndex インデックス
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Remove( int nIndex ) noexcept;

        //---------------------------------------------------------------------
        /// 削除関数
        ///
        /// 削除関数です。
        ///
        /// @param[in] nIndex インデックス
        /// @param[in] nCount 配列要素数
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Remove( int nIndex, int nCount ) noexcept;

        //---------------------------------------------------------------------
        /// 取得関数
        ///
        /// 取得関数です。
        ///
        /// @param[in] nIndex   インデックス
        /// @param[in] rElement 配列要素参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Get( int nIndex, Type& rElement ) const noexcept;

        //---------------------------------------------------------------------
        /// 設定関数
        ///
        /// 設定関数です。
        ///
        /// @param[in] nIndex   インデックス
        /// @param[in] rElement 配列要素参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Set( int nIndex, Type const& rElement ) noexcept;

        //---------------------------------------------------------------------
        /// 検索関数
        ///
        /// 検索関数です。
        ///
        /// @param[in] rElement 配列要素参照
        /// @return    インデックス
        /// -          0 以上 成功
        /// -          0 未満 失敗
        /// @attention なし
        ///
        virtual int Find( Type const& rElement ) const noexcept;

        //---------------------------------------------------------------------
        /// 比較関数
        ///
        /// 比較関数です。
        ///
        /// @param[in] rElement1 第１配列要素参照
        /// @param[in] rElement2 第２配列要素参照
        /// @return    実行結果
        /// -          true  一致
        /// -          false 不一致
        /// @attention なし
        ///
        virtual bool Compare( Type const& rElement1, Type const& rElement2 ) const noexcept;

        //---------------------------------------------------------------------
        /// プッシュ関数
        ///
        /// プッシュ関数です。
        ///
        /// @param[in] rElement 配列要素参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Push( Type const& rElement ) noexcept;

        //---------------------------------------------------------------------
        /// プッシュ関数
        ///
        /// プッシュ関数です。
        ///
        /// @param[in] pBuffer 配列要素ポインタ
        /// @param[in] nCount  配列要素数
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Push( Type const* pBuffer, int nCount ) noexcept;

        //---------------------------------------------------------------------
        /// プッシュ関数
        ///
        /// プッシュ関数です。
        ///
        /// @param[in] rcInitializer 配列要素初期化子リスト参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Push( std::initializer_list< Type const > const& rcInitializer ) noexcept;

        //---------------------------------------------------------------------
        /// ポップ関数
        ///
        /// ポップ関数です。
        ///
        /// @param[in] rElement 配列要素参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool Pop( Type& rElement ) noexcept;

        //---------------------------------------------------------------------
        /// ポップフロント関数
        ///
        /// ポップフロント関数です。
        ///
        /// @param[in] rElement 配列要素参照
        /// @return    実行結果
        /// -          true  成功
        /// -          false 失敗
        /// @attention なし
        ///
        virtual bool PopFront( Type& rElement ) noexcept;

        //=====================================================================
        // 限定公開変数
    protected:
        Type* m_pBuffer; ///< バッファポインタ
        int   m_nSize;   ///< バッファサイズ
        int   m_nCount;  ///< 要素数

        //=====================================================================
        // 静的公開定数
    public:
        static int const SEGMENT_SIZE = 256; ///< セグメントサイズ初期値
    };
}

#pragma managed( pop )