array_datatype.h

/*******************************************************************************
 * Copyright (C) 2015-2019 Commissariat a l'energie atomique et aux energies alternatives (CEA)
 * Copyright (C) 2020-2021 Institute of Bioorganic Chemistry Polish Academy of Science (PSNC)
 * 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 CEA nor the names of its contributors may be used to
 *   endorse or promote products derived from this software without specific
 *   prior written permission.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 ******************************************************************************/

#ifndef PDI_ARRAY_DATATYPE_H_
#define PDI_ARRAY_DATATYPE_H_

#include <memory>
#include <string>
#include <utility>
#include <vector>

#include <pdi/pdi_fwd.h>
#include <pdi/datatype.h>

namespace PDI {

class PDI_EXPORT Array_datatype:
    public Datatype
{
    Datatype_uptr m_subtype;
    
    size_t m_size;
    
    size_t m_start;
    
    size_t m_subsize;
    
public:
    class Index_accessor : public Datatype::Accessor_base
    {
        size_t m_index;
        
        std::string access_kind() const override;
    public:
        Index_accessor(size_t index);
        
        std::pair<void*, Datatype_uptr> access(const Array_datatype& array_type,
            void* from,
            std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_begin,
            std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_end) const override;
            
        std::unique_ptr<Accessor_base> clone() const override;
    };
    
    class Slice_accessor : public Datatype::Accessor_base
    {
        size_t m_start;
        
        size_t m_end;
        
        size_t size() const;
        
        std::string access_kind() const override;
    public:
        Slice_accessor(size_t start, size_t end);
        
        std::pair<void*, Datatype_uptr> access(const Array_datatype& array_type,
            void* from,
            std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_begin,
            std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_end) const override;
            
        std::unique_ptr<Accessor_base> clone() const override;
    };
    
    Array_datatype(Datatype_uptr subtype, size_t size, size_t start, size_t subsize, const Attributes_map& attributes = {});
    
    Array_datatype(Datatype_uptr subtype, size_t size, const Attributes_map& attributes = {});
    
    const Datatype& subtype() const;
    
    size_t size() const;
    
    size_t start() const;
    
    size_t subsize() const;
    
    Datatype_template_uptr clone() const override;
    
    Datatype_uptr clone_type() const override;
    
    Datatype_uptr densify() const override;
    
    Datatype_uptr evaluate(Context&) const override;
    
    bool dense() const override;
    
    size_t datasize() const override;
    
    size_t buffersize() const override;
    
    size_t alignment() const override;
    
    bool simple() const override;
    
    void* data_to_dense_copy(void*, const void*) const override;
    
    void* data_from_dense_copy(void*, const void*) const override;
    
    std::pair<void*, Datatype_uptr> subaccess_by_iterators(void* from,
        std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_begin,
        std::vector<std::unique_ptr<Accessor_base>>::const_iterator remaining_end) const override;
        
    void destroy_data(void*) const override;
    
    std::string debug_string() const override;
    
    bool operator== (const Datatype&) const override;
    
};

} // namespace PDI

#endif // PDI_ARRAY_DATATYPE_H_