Table.h

Go to the documentation of this file.

/*
 * (C) Copyright 2013 ECMWF.
 *
 * This software is licensed under the terms of the Apache Licence Version 2.0
 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
 * In applying this licence, ECMWF does not waive the privileges and immunities
 * granted to it by virtue of its status as an intergovernmental organisation
 * nor does it submit to any jurisdiction.
 */


#pragma once

#include <array>
#include <type_traits>

#include "atlas/util/Object.h"

#include "atlas/array.h"
#include "atlas/library/config.h"

namespace atlas {
namespace array {

// --------------------------------------------------------------------------


class Table : public util::Object {
private:
    static constexpr unsigned short _values_ = 0;
    static constexpr unsigned short _displs_ = 1;
    static constexpr unsigned short _counts_ = 2;

public:
    //-- Constructors

    Table( const std::string& name = "" );

    ~Table();

private:
    Table( idx_t values[], size_t rows, size_t displs[], size_t counts[] );

public:
    //-- Accessors

    const std::string& name() const { return name_; }

    void rename( const std::string& name ) { name_ = name; }

    size_t rows() const { return rows_; }

    size_t cols( size_t row_idx ) const { return counts_( row_idx ); }

    size_t maxcols() const { return maxcols_; }

    size_t mincols() const { return mincols_; }

    idx_t missing_value() const { return missing_value_; }

    size_t size() const { return data_[_values_]->size(); }

    virtual size_t footprint() const;

    virtual void updateDevice() const;

    virtual void updateHost() const;

    virtual void syncHostDevice() const;

    virtual bool valid() const;

    virtual bool hostNeedsUpdate() const;

    virtual bool deviceNeedsUpdate() const;

    void dump( std::ostream& ) const;

    bool owns() { return owns_; }


    virtual void add( size_t rows, size_t cols, const idx_t values[], bool fortran_array = false );

    virtual void add( size_t rows, size_t cols );

    virtual void add( size_t rows, const size_t cols[] );

    virtual void insert( size_t position, size_t rows, size_t cols, const idx_t values[], bool fortran_array = false );

    virtual void insert( size_t position, size_t rows, size_t cols );

    virtual void insert( size_t position, size_t rows, const size_t cols[] );

    virtual void clear();

private:

    void resize_values( size_t old_size, size_t size, bool initialize, const idx_t values[], bool fortran_array );

    void resize_counts_and_displs( size_t size );

    void insert_counts_and_displs( size_t position, size_t rows );

    void resize_values( size_t size );

    void insert_values( size_t position, size_t size );

private:
    template <bool ReadOnly>
    friend class TableView;

    std::string name_;
    bool owns_;
    std::array<array::Array*, 3> data_;
    idx_t missing_value_;
    size_t rows_;
    size_t maxcols_;
    size_t mincols_;
    ArrayView<size_t, 1> displs_;
    ArrayView<size_t, 1> counts_;
    ArrayView<idx_t, 1> values_;
};

//------------------------------------------------------------------------------------------------------

}  // namespace array
}  // namespace atlas