packed_arrays.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2000-2022 Inria
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  * Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright notice,
 *  this list of conditions and the following disclaimer in the documentation
 *  and/or other materials provided with the distribution.
 *  * Neither the name of the ALICE Project-Team nor the names of its
 *  contributors may be used to endorse or promote products derived from this
 *  software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *  POSSIBILITY OF SUCH DAMAGE.
 *
 *  Contact: Bruno Levy
 *
 *     https://www.inria.fr/fr/bruno-levy
 *
 *     Inria,
 *     Domaine de Voluceau,
 *     78150 Le Chesnay - Rocquencourt
 *     FRANCE
 *
 */
 
#ifndef GEOGRAM_BASIC_PACKED_ARRAYS
#define GEOGRAM_BASIC_PACKED_ARRAYS
 
#include <geogram/basic/common.h>
#include <geogram/basic/numeric.h>
#include <geogram/basic/assert.h>
#include <geogram/basic/process.h>
 
namespace GEO {
 
    class GEOGRAM_API PackedArrays {
    public:
    PackedArrays();
 
    ~PackedArrays();
 
    bool thread_safe() const {
        return thread_safe_;
    }
 
    void set_thread_safe(bool flag);
 
    void init(
        index_t nb_arrays,
        index_t Z1_block_size,
        bool static_mode = false
    );
 
    void clear();
 
    index_t nb_arrays() const {
        return nb_arrays_;
    }
 
    index_t array_size(index_t array_index) const {
        geo_debug_assert(array_index < nb_arrays_);
        return Z1_[array_index * Z1_stride_];
    }
 
    void get_array(
        index_t array_index, vector<index_t>& array, bool lock = true
    ) const {
        if(lock) {
            lock_array(array_index);
        }
        array.resize(array_size(array_index));
        if(array.size() != 0) {
            get_array(array_index, &array[0], false);
        }
        if(lock) {
            unlock_array(array_index);
        }
    }
 
    void get_array(
        index_t array_index, index_t* array, bool lock = true
    ) const;
 
    void set_array(
        index_t array_index,
        index_t array_size, const index_t* array_elements,
        bool lock = true
    );
 
    void set_array(
        index_t array_index,
        const vector<index_t>& array,
        bool lock = true
    ) {
        if(array.size() == 0) {
            set_array(array_index, 0, nullptr, lock);
        } else {
            set_array(
                array_index, index_t(array.size()), &array[0], lock
            );
        }
    }
 
    void resize_array(
        index_t array_index, index_t array_size, bool lock
    );
 
    void lock_array(index_t array_index) const {
        if(thread_safe_) {
            Z1_spinlocks_.acquire_spinlock(array_index);
        }
    }
 
    void unlock_array(index_t array_index) const {
        if(thread_safe_) {
            Z1_spinlocks_.release_spinlock(array_index);
        }
    }
 
    void show_stats();
 
    protected:
    bool static_mode() const {
        return ZV_ == nullptr;
    }
 
    private:
    PackedArrays(const PackedArrays& rhs);
 
    PackedArrays& operator= (const PackedArrays& rhs);
 
    private:
    index_t nb_arrays_;
    index_t Z1_block_size_;
    index_t Z1_stride_;
    index_t* Z1_;
    index_t** ZV_;
    bool thread_safe_;
    mutable Process::SpinLockArray Z1_spinlocks_;
    };
}
 
#endif