[Fortranのはじめ方] Part20: INTENT属性と副作用の明示

Fortranのプロシージャ（サブルーチンや関数）を書く際に、引数（ダミー引数）がどのように使われるかを明示することは、コードの可読性、保守性、そして安全性を高める上で非常に重要です。Fortran 90以降で導入されたINTENT属性は、この目的のために使われます。💪

INTENT属性を使うことで、引数がプロシージャ内でどのように扱われるか（入力専用か、出力専用か、あるいは入出力両用か）をコンパイラと他の開発者に伝えることができます。これにより、意図しない引数の変更（副作用）を防ぎ、コンパイラによる最適化やエラーチェックを助けます。

INTENT属性の種類

INTENT属性には以下の3種類があります。

属性	意味	説明
`INTENT(IN)`	入力専用	プロシージャ内で引数の値を参照するだけで、変更することはできません。この引数に対応する実引数は定数や式でも構いません。関数においては、引数は原則として`INTENT(IN)`にすることが推奨されます。
`INTENT(OUT)`	出力専用	プロシージャ内で引数に値を設定するために使われます。プロシージャ呼び出し時の引数の値は未定義となり、プロシージャ内で値を設定（定義）する必要があります。プロシージャから結果を返すために使われます。
`INTENT(INOUT)`	入出力両用	プロシージャ内で引数の値を参照することも、変更することもできます。入力値に基づいて計算し、その結果を同じ変数に格納するような場合に使われます。

注意: INTENT属性を省略した場合、デフォルトではINTENT(INOUT)とみなされることが多いですが、これはコンパイラや状況によって異なる可能性があり、意図しない動作の原因となることがあります。したがって、すべてのダミー引数にINTENT属性を明示的に指定することが強く推奨されます。

INTENT属性の利点と副作用の防止

プログラミングにおける「副作用」とは、関数やサブルーチンが、結果を返す以外に、外部の状態を変更してしまうことを指します。Fortranでは、特に引数の値を意図せず変更してしまうことが副作用の典型例です。

例えば、あるサブルーチンが、入力として受け取った配列の内容を、計算の途中で書き換えてしまう場合、呼び出し元のプログラムでは予期せぬ結果になる可能性があります。もしその引数が入力専用であるという意図があれば、INTENT(IN)を指定すべきです。

INTENT属性を適切に使うことには、以下のような利点があります。

意図の明確化: 引数がどのように使われるべきかが明確になり、コードを読む人が理解しやすくなります（自己文書化）。
エラー検出: コンパイラがINTENT属性に基づいてエラーチェックを行います。例えば、INTENT(IN)と宣言された引数をプロシージャ内で変更しようとすると、コンパイルエラーになります。これにより、意図しない副作用を未然に防ぐことができます。
最適化の促進: 引数の使われ方が明確になることで、コンパイラがより効果的な最適化を行う手助けとなる場合があります。
安全性の向上: 特に大規模なプログラムや複数人での開発において、予期せぬバグを防ぎ、コードの信頼性を高めます。

サブルーチンは副作用（引数の変更）を利用して結果を返すことがありますが、関数は通常、副作用なし（pure）であることが望ましいとされています。関数内で引数を変更する必要がある場合は、サブルーチンの使用を検討しましょう。

コード例

以下にINTENT属性を使った簡単な例を示します。

INTENT(IN) の例


subroutine print_vector_sum(n, vec)
  implicit none
  integer, intent(in) :: n          ! 配列のサイズ (入力専用)
  real, intent(in) :: vec(n)    ! 配列データ (入力専用)
  real :: total

  total = sum(vec)
  print *, "Vector sum:", total

  ! vec(1) = 0.0  ! これは INTENT(IN) なのでコンパイルエラーになる！

end subroutine print_vector_sum

INTENT(OUT) の例


subroutine compute_min_max(n, data, data_min, data_max)
  implicit none
  integer, intent(in) :: n            ! 配列サイズ (入力)
  real, intent(in) :: data(n)      ! データ配列 (入力)
  real, intent(out) :: data_min     ! 最小値 (出力専用)
  real, intent(out) :: data_max     ! 最大値 (出力専用)

  ! data_min, data_max は呼び出し時の値は未定義。ここで設定する。
  if (n > 0) then
    data_min = minval(data)
    data_max = maxval(data)
  else
    data_min = 0.0  ! またはエラー処理
    data_max = 0.0
  endif

end subroutine compute_min_max

INTENT(INOUT) の例


subroutine scale_vector(n, vec, factor)
  implicit none
  integer, intent(in) :: n             ! 配列サイズ (入力)
  real, intent(inout) :: vec(n)       ! スケーリングする配列 (入出力)
  real, intent(in) :: factor         ! スケーリング係数 (入力)
  integer :: i

  ! vec の値を読み取り、計算結果を vec に書き戻す
  do i = 1, n
    vec(i) = vec(i) * factor
  end do

end subroutine scale_vector

まとめ

INTENT属性は、Fortranプロシージャの引数の役割を明確にし、副作用を防ぐための重要な機能です。コードの可読性、安全性、保守性を向上させるために、積極的に活用しましょう。特にINTENT(IN)を適切に使うことで、意図しないデータの書き換えを防ぎ、より堅牢なプログラムを作成できます。✨

次のステップでは、再帰関数やPURE属性など、さらにモダンなFortranの機能について学んでいきましょう。

参考情報

Fortran Best Practices – Argument Intents (Fortran-lang.org) – 英語ですが、INTENT属性に関するベストプラクティスが説明されています。
IBM Documentation – INTENT – IBMコンパイラのドキュメントですが、INTENT属性の詳細な説明があります（英語）。