tuple.h

/* Jazz (c) 2018-2025 kaalam.ai (The Authors of Jazz), using (under the same license):
 
    1. Biomodelling - The AATBlockQueue class (c) Jacques Basaldúa, 2009-2012 licensed
      exclusively for the use in the Jazz server software.
 
      Copyright 2009-2012 Jacques Basaldúa
 
    2. BBVA - Jazz: A lightweight analytical web server for data-driven applications.
 
      Copyright 2016-2017 Banco Bilbao Vizcaya Argentaria, S.A.
 
      This product includes software developed at
 
      BBVA (https://www.bbva.com/)
 
    3. LMDB, Copyright 2011-2017 Howard Chu, Symas Corp. All rights reserved.
 
      Licensed under http://www.OpenLDAP.org/license.html
 
 
      Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
      http://www.apache.org/licenses/LICENSE-2.0
 
      Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/
 
 
#include <map>
 
 
#include "src/jazz_elements/kind.h"
 
#ifdef CATCH_TEST
#ifndef INCLUDED_JAZZ_CATCH2
#define INCLUDED_JAZZ_CATCH2
 
#include "src/catch2/catch.hpp"
 
#endif
#endif
 
 
#ifndef INCLUDED_JAZZ_ELEMENTS_TUPLE
#define INCLUDED_JAZZ_ELEMENTS_TUPLE
 
 
namespace jazz_elements
{
 
class Tuple : public Block {
 
    public:
 
    // Methods to create a Tuple:
 
        inline StatusCode new_tuple(int           num_items,
                                    pBlock        blocks[],
                                    Name          p_names[],
                                    int           num_bytes,
                                    AttributeMap *att = nullptr) {
 
            if (num_items < 1 || num_items > MAX_ITEMS_IN_KIND)
                return SERVICE_ERROR_WRONG_ARGUMENTS;
 
            int rq_sz = sizeof(BlockHeader) + sizeof(StringBuffer) + num_items*sizeof(ItemHeader) + 2*num_items;
 
            if (att != nullptr)
                rq_sz += 2*att->size();
 
            if (num_bytes < rq_sz)
                return SERVICE_ERROR_NO_MEM;
 
            memset(&cell_type, 0, rq_sz);
 
            cell_type    = CELL_TYPE_TUPLE_ITEM;
            rank         = 1;
            range.dim[0] = 1;
            size         = num_items;
            total_bytes  = num_bytes;
 
            set_attributes(att);
 
            pStringBuffer psb = p_string_buffer();
 
            for (int i = 0; i < num_items; i++) {
                pBlock p_block = blocks[i];
                if (p_block == nullptr)
                    return SERVICE_ERROR_WRONG_ARGUMENTS;
 
                ItemHeader *p_it_hea = &tensor.cell_item[i];
 
                if ((p_block->cell_type & 0xff) > 8)
                    return SERVICE_ERROR_WRONG_TYPE;
 
                pChar p_name = (pChar) &p_names[i];
 
                if (!valid_name(p_name))
                    return SERVICE_ERROR_WRONG_NAME;
 
                p_it_hea->cell_type = p_block->cell_type;
                p_it_hea->name      = get_string_offset(psb, p_name);
                p_it_hea->rank      = p_block->rank;
                p_block->get_dimensions((int *) &p_it_hea->dim);
 
                if (p_it_hea->name <= STRING_EMPTY)
                    return SERVICE_ERROR_NO_MEM;
            }
 
            int *p_dest = align64bit((uintptr_t) &psb->buffer[psb->last_idx]);
 
            if ((uintptr_t) p_dest - (uintptr_t) &cell_type > num_bytes)
                return SERVICE_ERROR_NO_MEM;                    // May never happen. "(p_it_hea->name <= STRING_EMPTY)" catches it first.
 
            psb->buffer_size = (uintptr_t) p_dest - ((uintptr_t) &psb->buffer[0]);
 
            for (int i = 0; i < num_items; i++) {
                pBlock p_block = blocks[i];
                ItemHeader *p_it_hea = &tensor.cell_item[i];
 
                p_it_hea->data_start = (uintptr_t) p_dest - (uintptr_t) &tensor;
 
                if ((uintptr_t) p_dest - (uintptr_t) &cell_type + p_block->total_bytes > num_bytes)
                    return SERVICE_ERROR_NO_MEM;
 
                memcpy(p_dest, p_block, p_block->total_bytes);
 
                p_dest = align64bit((uintptr_t) p_dest + p_block->total_bytes);
            }
 
            return SERVICE_NO_ERROR;
        }
 
        inline char *item_name(int idx) {
            if (idx < 0 || idx >= size)
                return nullptr;
 
            return reinterpret_cast<char *>(&p_string_buffer()->buffer[tensor.cell_item[idx].name]);
        }
 
        inline int index(pChar name) {
            for (int idx = 0; idx < size; idx++)
                if (strcmp(reinterpret_cast<char *>(&p_string_buffer()->buffer[tensor.cell_item[idx].name]), name) == 0)
                    return idx;
 
            return -1;
        }
 
        inline pBlock get_block(int idx) {
            if (idx < 0 | idx >= size)
                return nullptr;
 
            return (pBlock) ((uintptr_t) &tensor + tensor.cell_item[idx].data_start);
        }
 
    // Tuple/Kind specific methods:
 
        inline bool is_a(pKind kind) {
            if (kind->cell_type != CELL_TYPE_KIND_ITEM || kind->size != size)
                return false;
 
            std::map<std::string, int> dimension;
 
            for (int i = 0; i < size; i++) {
                if (  kind->tensor.cell_item[i].cell_type != tensor.cell_item[i].cell_type
                    || kind->tensor.cell_item[i].rank     != tensor.cell_item[i].rank)
                    return false;
 
                if (strcmp(kind->item_name(i), item_name(i)))
                    return false;
 
                for (int j = 0; j < tensor.cell_item[i].rank; j++) {
                    int d_k = kind->tensor.cell_item[i].dim[j];
 
                    if (d_k < 0) {
                        std::string dim_name(reinterpret_cast<char *>(&kind->p_string_buffer()->buffer[-d_k]));
                        if (dimension.count(dim_name)) {
                            if (dimension[dim_name] != tensor.cell_item[i].dim[j])
                                return false;
                        } else {
                            dimension[dim_name] = tensor.cell_item[i].dim[j];
                        }
                    } else {
                        if (d_k != tensor.cell_item[i].dim[j])
                            return false;
                    }
                }
            }
 
            return true;
        }
 
        int audit();
};
typedef Tuple *pTuple;      
 
} // namespace jazz_elements
 
#endif // ifndef INCLUDED_JAZZ_ELEMENTS_TUPLE