함수 주석(Function Annotations)¶

도함수(derivative)¶

다항식 해석(Polynomial Evaluation) 예제에서 본 것처럼 모델리카 컴파일러에 주어진 함수의 도함수를 계산하는 방법을 알려주고 싶은 상황이 있습니다. 이는 함수에 derivative 주석을 추가하여 수행됩니다.

function f
  input Real x;
  input Real y;
  output Real z;
  annotation ...
algorithm
  z := // some expression involving x and y
end f;

function df
  input Real x;
  input Real y;
  input Real dx;
  input Real dy;
  output Real dz;
algorithm
  dz := // some expression involving x, y, dx and dy
end df;

function f
  input Real x;
  input Real y;
  output Real z;
  annotation ...
algorithm
  z := // some expression involving x and y
end f;

function df_onlyx
  input Real x;
  input Real y;
  input Real dx;
  output Real dz;
algorithm
  dz := // some expression involving x, y, dx
end df_onlyx;

function f
  input Real x;
  input Real y;
  output Real z;
  annotation ...
algorithm
  z := // some expression involving x and y
end f;

function df
  ...
end df;

function ddf
  input Real x;
  input Real y;
  input Real dx;
  input Real dy;
  input Real ddx;
  input Real ddy;
  output Real ddz;
algorithm
  ddz := // some expression involving x, y, dx, dy,
        // ddx and ddz
end ddf;

annotation ...

function g
  input Real x;
  input Integer y;
  output Real z;
algorithm
  z := // some expression involving x and y
end g;

function g
  input Real x;
  input Integer y;
  output Real z;
  annotation ...
algorithm
  z := // some expression involving x and y
end g;

function dg
  input Real x;
  input Integer y;
  input Real dx;
  output Real dz;
algorithm
  dz := // some expression involving x, y and dx
end dg;

inverse¶

비선형성(Non-Linearities) 에 대한 토론 중에 inverse 주석을 사용하여 모델리카 컴파일러에 함수의 역을 계산하는 방법을 알려주는 방법을 다루었습니다.역함수의 목표는 현재 함수의 입력 인수 중 하나에 대해 명시적으로 해결하는 것입니다.이와 같이 inverse 주석에는 현재 함수의 입력 및 출력 변수를 포함하는 명시적 방정식이 포함되지만 입력 인수 중 하나를 명시적으로 계산하기 위해 다른 함수와 함께 사용합니다.

예를 들어 다음과 같이 정의된 모델리카 함수의 경우

 function h
   input Real a;
   input Real b;
   output Real c;
   annotation ...
algorithm
   c := // some calculation involving a and b
end h;

정의되는 h_inv_b 함수에 a 와 c 를 인수로 전달하여 b 를 계산할 수 있음을 알 수 있습니다.

 function h_inv_b
   input Real a;
   input Real c;
   output Real b;
algorithm
   b := // some calculation involving a and c
end h_inv_b;

Inline¶

Inline 주석은 함수의 명령문이 "inline" 되어야 한다는 모델리카 컴파일러에게 주는 힌트이며, 주석 값은 인라인을 수행해야 하는지 여부를 제안하는 데 사용합니다. 기본값(Inline 주석이 없는 경우)은 false 입니다.다음은 Inline 주석을 사용하는 함수입니다:

function SimpleCalculation
  input Real x;
  input Real y;
  output Real z;
  annotation ...
algorithm
  z := 2*x-y;
end SimpleCalculation;

여기에서 Inline 주석은 모델리카 컴파일러가 SimpleCalculation 함수를 인라인해야 함을 시사합니다.함수 호출을 출력 결과를 계산하는 함수의 명령문으로 대체하여 함수가 인라인되며, 매우 간단한 계산을 수행하는 함수에 유용합니다. 함수를 호출하는 "비용"(CPU 시간)은 함수가 수행하는 작업의 비용과 같은 수준인데, 이런경우 함수를 인라인하면 목적을 유지하면서 함수 호출 비용을 제거할 수 있습니다.

Inline 기능은 모델리카 컴파일러에 대한 힌트일 뿐이며, 컴파일러는 함수를 인라인할 의무가 없습니다. 또한 함수를 인라인하는 컴파일러의 기능은 함수의 복잡성에 따라 달라집니다.일반적으로 함수를 인라인하는 것이 반드시 가능하거나 바람직하지는 않습니다.

LateInline¶

Inline 주석과 마찬가지로 LateInline 함수는 모델리카 컴파일러에게 함수를 인라인하는 것이 더 효율적일 것이라고 알려줍니다.``LateInline`` 주석에는 함수를 인라인할지 여부를 지정하는 Boolean 값도 할당합니다.``Inline`` 주석과 LateInline 주석의 차이점은 LateInline 은 기호 조작이 수행된 후에 인라인을 수행 해야 함을 나타낸다는 점 입니다.하지만, 인라인과 다른 기호 조작 간의 잠재적인 상호 작용에 대한 자세한 논의는 이 책의 범위를 벗어나므로 다루지 않겠습니다.

LateInline 주석이 둘 다 함수에 적용되는 경우 Inline 주석보다 우선한다는 점에 유의해야 합니다. 즉, 아래와 같습니다.

Include¶

Include 주석은 모델리카 컴파일러에서 생성된 코드에 include 문이 필요할 때마다 사용되며,일반적으로 이것은 외부 라이브러리를 참조할 때 필요합니다. Include 주석의 값은 생성된 코드에 삽입되어야 하는 것에 대한 문자열 입니다.

annotation ...

IncludeDirectory¶

앞서 살펴본 바와 같이 Include 주석을 사용하면 생성된 코드에 삽입할 수 있고, IncludeDirectory 주석은 Include 주석으로 지정된 콘텐츠를 찾기 위해 검색해야 하는 디렉토리를 지정합니다.

이 주석의 값은 문자열이며, 디렉토리를 나타내거나 URL을 표현할 수 있습니다. 예를 들어 IncludeDirectory 주석의 기본값은 다음과 같습니다.

IncludeDirectory=modelica://LibraryName/Resources/Include

이러한 modelica:// URLs 의 의미를 곧 설명하겠습니다.

Library¶

Library 주석은 함수가 의존할 수 있는 컴파일된 라이브러리를 지정하는 데 사용되며, library의 값은 라이브러리의 이름을 나타내는 간단한 문자열이거나 이러한 문자열의 배열일 수 있습니다.

annotation ...

혹은

annotation ...

모델리카 컴파일러는 생성된 코드를 "연결"하는 동안 이 정보를 사용합니다.

LibraryDirectory¶

Include 와 같은 문제가 Library 에도 존재합니다. Library 주석은 추가해야 할 항목을 알려주지만 찾을 위치는 알려주지 않습니다. 이런 식으로 LibraryDirectory 주석은 IncludeDirectory 주석과 같은 역할을 합니다. IncludeDirectory 주석과 마찬가지로 URL일 수도 있습니다. 기본값은 다음과 같습니다.

LibraryDirectory=modelica://LibraryName/Resources/Library