보간(Interpolation)¶

생성자(Constructor)¶

constructor 함수는 VectorTable 인스턴스가 생성될 때 호출됩니다(예: 테스트 사례에서 vector 변수의 선언). 이 constructor 함수는 불투명 포인터를 초기화하는 데 사용합니다. 초기화 프로세스의 일부로 필요한 데이터는 무엇이든 constructor 함수에 대한 인수로 전달되어야 합니다. 동일한 데이터가 인스턴스화 중에 존재해야 합니다(예를들어, vector 변수 선언의 데이터 인자).

constructor 함수의 정의는 이전 예제와 달리 algorithm 섹션을 포함하지 않기 때문에 일반적이지 않습니다. algorithm 섹션은 일반적으로 함수의 반환 값을 계산하는 데 사용하는데, 그 대신에 constructor 함수에는 external 절이 있습니다. 이는 모델리카 이외의 다른 언어로 기능이 구현되었음을 나타냅니다. 이 경우 다른 언어는 C입니다(external 키워드 다음에 나오는 "C" 로 표시됨).이것은 table 변수(이 함수의 출력 이며 불투명한 포인터를 나타냄)가``createVectorTable`` 이라는 C 함수와 ybar 변수의 크기에 의해 반환된다는 것을 알려줍니다.

createVectorTable 호출 다음에는 annotation 이 있습니다. 이 주석은 이 외부 C 함수의 소스 코드를 찾을 위치를 모델리카 컴파일러에 알려줍니다.

여기서 중요한 점은 모델리카 컴파일러의 관점에서 볼 때 VectorTable 은 createVectorTable 에 의해 반환된 불투명한 포인터일 뿐이라는 것입니다. 모델리카에서 이 포인터 뒤에 있는 데이터에 액세스하는 것은 불가능합니다.

소멸자(Destructor)¶

destructor 함수는 ExternalObject 가 더 이상 필요하지 않을 때마다 호출됩니다. 이렇게 하면 모델리카 런타임이 ExternalObject 에서 사용하는 메모리를 정리할 수 있습니다. 모델에서 인스턴스화된 ExternalObject 는 일반적으로 시뮬레이션이 끝날 때까지 지속됩니다. 그러나 예를 들어 함수에서 protected 변수로 선언된 ExternalObject 는 단일 표현식 해석 과정에서 생성되고 소멸될 수 있습니다.따라서 ExternalObject 에 의해 할당된 메모리가 해제되었는지 확인하는 것이 중요합니다.

일반적으로 destructor 함수는 외부 함수로도 구현됩니다. 이 경우 모델리카에서 destructor 함수를 호출하면 VectorTable 인스턴스가 인수로 전달되는 C 함수 destroyVectorTable 이 호출됩니다. 해당 VectorTable 인스턴스와 관련된 모든 메모리는 destructor 호출로 해제되어야 합니다. 다시, destoryVectorTable 함수의 소스 코드를 찾을 위치를 모델리카 컴파일러에 알리는 데 사용하는 동일한 자료형의 annotations을 볼 수 있습니다.

외부 C 코드(External C Code)¶

이전의 예제에서 호출했던 외부 C 함수는 다음과 같이 구현됩니다.

#ifndef _VECTOR_TABLE_C_
#define _VECTOR_TABLE_C_

#include <stdlib.h>
#include "ModelicaUtilities.h"

/*
  Here we define the structure associated
  with our ExternalObject type 'VectorTable'
*/
typedef struct {
  double *x; /* Independent variable values */
  double *y; /* Dependent variable values */
  size_t npoints; /* Number of points in this data */
  size_t lastIndex; /* Cached value of last index */
} VectorTable;

void *
createVectorTable(double *data, size_t np) {
  VectorTable *table = (VectorTable*) malloc(sizeof(VectorTable));
  if (table) {
    /* Allocate memory for data */
    table->x = (double*) malloc(sizeof(double)*np);
    if (table->x) {
      table->y = (double*) malloc(sizeof(double)*np);
      if (table->y) {
        /* Copy data into our local array */
        size_t i;
        for(i=0;i<np;i++) {
          table->x[i] = data[2*i];
          table->y[i] = data[2*i+1];
        }
        /* Initialize the rest of the table object */
        table->npoints = np;
        table->lastIndex = 0;
      }
      else {
        free(table->x);
        free(table);
        table = NULL;
        ModelicaError("Memory allocation error\n");
      }
    }
    else {
      free(table);
      table = NULL;
      ModelicaError("Memory allocation error\n");
    }
  }
  else {
    ModelicaError("Memory allocation error\n");
  }
  return table;
}

void
destroyVectorTable(void *object) {
  VectorTable *table = (VectorTable *)object;
  if (table==NULL) return;
  free(table->x);
  free(table->y);
  free(table);
}

double
interpolateVectorTable(void *object, double x) {
  VectorTable *table = (VectorTable *)object;
  size_t i = table->lastIndex;
  double p;

  ModelicaFormatMessage("Request to compute value of y at %g\n", x);
  if (x<table->x[0])
    ModelicaFormatError("Requested value of x=%g is below the lower bound of %g\n",
      x, table->x[0]);
  if (x>table->x[table->npoints-1])
    ModelicaFormatError("Requested value of x=%g is above the upper bound of %g\n",
      x, table->x[table->npoints-1]);

  while(i<table->npoints-1&&x>table->x[i+1]) i++;
  while(i>0&&x<table->x[i]) i--;

  p = (x-table->x[i])/(table->x[i+1]-table->x[i]);
  table->lastIndex = i;
  return p*table->y[i+1]+(1-p)*table->y[i];
}

#endif

이 책은 C 프로그래밍 언어에 관한 책이 아니므로 이 코드에 대한 철저한 검토와 코드가 정확히 어떻게 작동하는지에 대해서 다루는 것은 책의 범위를 벗어납니다.하지만 이 파일의 내용을 다음과 같이 요약할 수 있습니다.

먼저 VectorTable 이라는 struct 는 모델리카에서 VectorTable 자료형과 관련된 데이터입니다. 여기에는 보간 데이터(x 및 y 멤버 형식)뿐만 아니라 데이터 포인트 수 npoints 및 마지막으로 사용된 인덱스에 대해 캐시된 값 lastIndex 도 포함됩니다.

다음으로 VectorTable 구조의 인스턴스를 할당하고 그 안의 모든 데이터를 초기화하는 createVectorTable 함수를 보면, 해당 인스턴스가 모델리카 런타임으로 반환 되는 것을 알 수 있습니다.``createVectorTable`` 정의 다음에는 createVectorTable 에 의해 수행된 작업을 효과적으로 취소하는 destroyVectorTable 정의가 있습니다.

마지막으로 interpolateVectorTable 함수를 보겠습니다. 이것은 VectorTable 구조의 인스턴스와 독립 변수에 대한 값을 전달하고 종속 변수에 대한 보간된 값을 반환하는 C 함수인데, 앞에서 제시한 InterpolateVector 함수와 거의 동일한 기능을 수행합니다. 모델리카 런타임은 외부 C 코드가 오류를 보고할 수 있도록 ModelicaFormatError 와 같은 기능을 제공합니다. interpolateVectorTable 함수는 이전에 InterpolateVector 에서 보았던 내용을 구현하는 데 사용합니다. i 조회는 매번 1부터 시작하는 대신 interpolateVectorTable 에 대한 마지막 호출에서 찾은 i 값에서 시작한다는 점을 제외하면 기본적으로 동일합니다.

보간(Interpolation)¶

interpolateVectorTable 이 어떻게 정의되는지 보았지만 지금까지 그것이 어디에 사용하는지는 보지 못했습니다. InterpolateVector 와 거의 같은 역할을 수행하지만, VectorTable 객체를 사용하여 보간 데이터를 표현한다고 언급했습니다. 모델리카에서 interpolateVectorTable 을 호출하려면 다음과 같이 모델리카 함수를 정의하기만 하면 됩니다.

function InterpolateExternalVector
  "Interpolate a function defined by a vector using an ExternalObject"
  input Real x;
  input VectorTable table;
  output Real y;
  external "C" y = interpolateVectorTable(table, x)
    annotation ...
end InterpolateExternalVector;

이전에 VectorTable 이 불투명하고 모델리카 코드가 VectorTable 에 포함된 데이터에 액세스할 수 없다고 언급했습니다. 모델리카 함수 InterpolateExternalVector 는 보간 데이터에 접근 할 수 있는 C 대응 interpolateVectorTable 을 호출하여 보간을 수행합니다.