/*
 * This file belongs to the OpenModelica Run-Time System
 *
 * Copyright (c) 1998-2026, Open Source Modelica Consortium (OSMC), c/o Linköpings
 * universitet, Department of Computer and Information Science, SE-58183 Linköping, Sweden. All rights
 * reserved.
 *
 * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF THE BSD NEW LICENSE OR THE
 * AGPL VERSION 3 LICENSE OR THE OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.8. ANY
 * USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES RECIPIENT'S
 * ACCEPTANCE OF THE BSD NEW LICENSE OR THE OSMC PUBLIC LICENSE OR THE AGPL
 * VERSION 3, ACCORDING TO RECIPIENTS CHOICE.
 *
 * The OpenModelica software and the OSMC (Open Source Modelica Consortium) Public License
 * (OSMC-PL) are obtained from OSMC, either from the above address, from the URLs:
 * http://www.openmodelica.org or https://github.com/OpenModelica/ or
 * http://www.ida.liu.se/projects/OpenModelica, and in the OpenModelica distribution. GNU
 * AGPL version 3 is obtained from: https://www.gnu.org/licenses/licenses.html#GPL. The BSD NEW
 * License is obtained from: http://www.opensource.org/licenses/BSD-3-Clause.
 *
 * This program is distributed WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY
 * SET FORTH IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF
 * OSMC-PL.
 *
 */

#ifndef OMC_ARRAY_INDEX_H
#define OMC_ARRAY_INDEX_H

#include "../simulation_data.h"
#include "../util/varinfo.h"

#ifdef __cplusplus
extern "C"
{
#endif

  void allocateArrayIndexMaps(MODEL_DATA *modelData,
                              SIMULATION_INFO *simulationInfo,
                              threadData_t *threadData);

  void freeArrayIndexMaps(SIMULATION_INFO *simulationInfo);

  void allocateArrayReverseIndexMaps(MODEL_DATA *modelData,
                                     SIMULATION_INFO *simulationInfo,
                                     threadData_t *threadData);

  void freeArrayReverseIndexMaps(SIMULATION_INFO *simulationInfo);

  size_t calculateLength(DIMENSION_INFO *dimensionInfo,
                         STATIC_INTEGER_DATA *integerParameterData,
                         long nParametersIntegerArray);

  void printFlattenedNames(FILE *stream,
                           const char *separator,
                           const char *name,
                           DIMENSION_INFO *dimension_info);

  size_t multiDimArrayToLinearIndex(DIMENSION_INFO *dimension,
                                    size_t *array_index);

  size_t *linearToMultiDimArrayIndex(DIMENSION_INFO *dimension,
                                     size_t linear_address);

  void calculateAllScalarLength(MODEL_DATA *modelData);

  void computeVarIndices(SIMULATION_INFO *simulationInfo,
                         MODEL_DATA *modelData);

  void computeVarsReverseIndex(void *variableData,
                               enum var_type type,
                               size_t num_variables,
                               array_index_t* reverseIndex);

  void computeVarReverseIndices(SIMULATION_INFO *simulationInfo,
                                MODEL_DATA *modelData);

  modelica_real getStartFromScalarIdx(const SIMULATION_INFO *simulationInfo,
                                      const MODEL_DATA *modelData,
                                      enum var_type type,
                                      enum var_kind kind,
                                      size_t scalar_idx);

  modelica_real getNominalFromScalarIdx(const SIMULATION_INFO *simulationInfo,
                                        const MODEL_DATA *modelData,
                                        enum var_kind kind,
                                        size_t scalar_idx);

  modelica_real getMinFromScalarIdx(const SIMULATION_INFO *simulationInfo,
                                    const MODEL_DATA *modelData,
                                    enum var_type type,
                                    enum var_kind kind,
                                    size_t scalar_idx);

  modelica_real getMaxFromScalarIdx(const SIMULATION_INFO *simulationInfo,
                                    const MODEL_DATA *modelData,
                                    enum var_type type,
                                    enum var_kind kind,
                                    size_t scalar_idx);

#ifdef __cplusplus
}
#endif

#endif
