dc_present.f90

Go to the documentation of this file.

! -*- mode: f90; coding: utf-8 -*-
!-----------------------------------------------------------------------
! Copyright (c) 2000-2026 Gtool Development Group. All rights reserved.
!-----------------------------------------------------------------------
!>
!> @author    Youhei SASAKI, Yasuhiro MORIKAWA, Eizi TOYODA, Takeshi HORINOUCHI
!> @copyright Copyright (C) GFD Dennou Club, 2000-2026. All rights reserved. <br/>
!>            License is BSD-2-Clause. see [COPYRIGHT](@ref COPYRIGHT) in detail
!>
!> **Important**
!>
!> This file is generated from ../../../../src/dc_utils/dc_present.erb by ERB included Ruby 3.3.8.
!> Please do not edit this file directly.
!>
!> @en
!> @brief Judge optional control parameters
!> @details
!> This module provides utility functions for checking optional arguments.
!> These functions check whether an optional argument is present and
!> whether it satisfies certain conditions (true, false, zero, equal to a value, etc.).
!>
!> @section present_procedures Procedures List
!>
!> | Procedure            | Description                                              |
!> |----------------------|----------------------------------------------------------|
!> | present_and_true     | Returns .true. if arg is present and .true.              |
!> | present_and_false    | Returns .true. if arg is present and .false.             |
!> | present_and_zero     | Returns .true. if arg is present and equals zero         |
!> | present_and_nonzero  | Returns .true. if arg is present and not zero            |
!> | present_and_eq       | Returns .true. if arg is present and equals val          |
!> | present_and_ne       | Returns .true. if arg is present and not equals val      |
!> | present_and_not_empty| Returns .true. if arg is present and not empty string    |
!> | present_select       | Returns the first valid optional argument or default     |
!>
!> @enden
!>
!> @ja
!> @brief 省略可能な制御パラメータの判定
!> @details
!> 省略可能な引数のチェックに使用するユーティリティ関数を提供するモジュールです。
!> これらの関数は、省略可能な引数が与えられているかどうか、
!> また特定の条件（真、偽、ゼロ、指定値と等しいか、など）を満たすかどうかを判定します。
!>
!> @section present_procedures_ja 手続一覧
!>
!> | 手続名               | 説明                                                     |
!> |----------------------|----------------------------------------------------------|
!> | present_and_true     | arg が省略されておらず .true. の場合に .true. を返す     |
!> | present_and_false    | arg が省略されておらず .false. の場合に .true. を返す    |
!> | present_and_zero     | arg が省略されておらず 0 の場合に .true. を返す          |
!> | present_and_nonzero  | arg が省略されておらず 0 でない場合に .true. を返す      |
!> | present_and_eq       | arg が省略されておらず val と等しい場合に .true. を返す  |
!> | present_and_ne       | arg が省略されておらず val と等しくない場合に .true. を返す |
!> | present_and_not_empty| arg が省略されておらず空文字でない場合に .true. を返す   |
!> | present_select       | 最初の有効な省略可能引数またはデフォルト値を返す         |
!>
!> @endja
!>
module dc_present
  use dc_types, only: sp, sp_eps, dp, dp_eps, token, string
  private
  public :: present_and_true
  public :: present_and_false
  public :: present_and_zero
  public :: present_and_nonzero
  public :: present_and_eq
  public :: present_and_ne
  public :: present_and_not_empty
  public :: present_select
  interface present_and_eq
    module procedure present_and_eq_integer
    module procedure present_and_eq_real
    module procedure present_and_eq_double
  end interface
  interface present_and_ne
    module procedure present_and_ne_integer
    module procedure present_and_ne_real
    module procedure present_and_ne_double
  end interface present_and_ne
  interface present_select
    module procedure present_select_char
    module procedure present_select_char_auto
    module procedure present_select_int
    module procedure present_select_int_auto
    module procedure present_select_real
    module procedure present_select_real_auto
    module procedure present_select_double
    module procedure present_select_double_auto
  end interface present_select
contains
  !> @en
  !> @brief Check if arg is present and true
  !> @param[in] arg Optional logical argument
  !> @return .true. if arg is present and .true., .false. otherwise
  !> @enden
  !>
  !> @ja
  !> @brief arg が省略されておらず真かどうかを判定
  !> @param[in] arg 省略可能な論理型引数
  !> @return arg が省略されておらず .true. の場合は .true.、それ以外は .false.
  !> @endja
  function present_and_true(arg) result(result)
    logical                       :: result
    logical, intent(in), optional :: arg
    continue
    if(present(arg)) then
      if(arg) then
        result=.true.
      else
        result=.false.
      endif
    else
      result=.false.
    endif
  end function present_and_true
  !> @en
  !> @brief Check if arg is present and false
  !> @param[in] arg Optional logical argument
  !> @return .true. if arg is present and .false., .false. otherwise
  !> @enden
  !>
  !> @ja
  !> @brief arg が省略されておらず偽かどうかを判定
  !> @param[in] arg 省略可能な論理型引数
  !> @return arg が省略されておらず .false. の場合は .true.、それ以外は .false.
  !> @endja
  function present_and_false(arg) result(result)
    logical                       :: result
    logical, intent(in), optional :: arg
    continue
    if(present(arg)) then
      if(arg) then
        result=.false.
      else
        result=.true.
      endif
    else
      result=.false.
    endif
  end function present_and_false
  !> @en
  !> @brief Check if arg is present and zero
  !> @param[in] arg Optional integer argument
  !> @return .true. if arg is present and equals zero, .false. otherwise
  !> @enden
  !>
  !> @ja
  !> @brief arg が省略されておらず 0 かどうかを判定
  !> @param[in] arg 省略可能な整数型引数
  !> @return arg が省略されておらず 0 の場合は .true.、それ以外は .false.
  !> @endja
  function present_and_zero(arg) result(result)
    logical                       :: result
    integer, intent(in), optional :: arg
    continue
    if(present(arg)) then
      if(arg==0) then
        result=.true.
      else
        result=.false.
      endif
    else
      result=.false.
    endif
  end function present_and_zero
  !> @en
  !> @brief Check if arg is present and non-zero
  !> @param[in] arg Optional integer argument
  !> @return .true. if arg is present and not equals zero, .false. otherwise
  !> @enden
  !>
  !> @ja
  !> @brief arg が省略されておらず 0 でないかどうかを判定
  !> @param[in] arg 省略可能な整数型引数
  !> @return arg が省略されておらず 0 でない場合は .true.、それ以外は .false.
  !> @endja
  function present_and_nonzero(arg) result(result)
    logical                       :: result
    integer, intent(in), optional :: arg
    continue
    if(present(arg)) then
      if(arg==0) then
        result=.false.
      else
        result=.true.
      endif
    else
      result=.false.
    endif
  end function present_and_nonzero
  !> @en
  !> @brief Check if arg is present and equals val (integer version)
  !> @param[in] arg Optional integer argument
  !> @param[in] val Value to compare
  !> @return .true. if arg is present and equals val, .false. otherwise
  !> @enden
  !>
  !> @ja
  !> @brief arg が省略されておらず val と等しいかどうかを判定（整数版）
  !> @param[in] arg 省略可能な整数型引数
  !> @param[in] val 比較する値
  !> @return arg が省略されておらず val と等しい場合は .true.、それ以外は .false.
  !> @endja
  function present_and_eq_integer(arg,val) result(result)
    logical                       :: result
    integer, intent(in), optional :: arg
    integer, intent(in)           :: val
    continue
    result = .false.
    if(present(arg)) then
      if(arg==val) then
        result=.true.
      else
        result=.false.
      endif
    else
      result=.false.
    endif
  end function present_and_eq_integer
  !> @en
  !> @brief Check if arg is present and equals val (single precision version)
  !> @param[in] arg Optional single precision real argument
  !> @param[in] val Value to compare
  !> @return .true. if arg is present and equals val within SP_EPS, .false. otherwise
  !> @enden
  !>
  !> @ja
  !> @brief arg が省略されておらず val と等しいかどうかを判定（単精度版）
  !> @param[in] arg 省略可能な単精度実数型引数
  !> @param[in] val 比較する値
  !> @return arg が省略されておらず SP_EPS 以内で val と等しい場合は .true.、それ以外は .false.
  !> @endja
  function present_and_eq_real(arg,val) result(result)
    logical                        :: result
    real(sp), intent(in), optional :: arg
    real(sp), intent(in)           :: val
    continue
    result = .false.
    if(present(arg)) then
      if( abs(arg - val) .le. sp_eps ) then
        result=.true.
      else
        result=.false.
      endif
    else
      result=.false.
    endif
  end function present_and_eq_real
  !> @en
  !> @brief Check if arg is present and equals val (double precision version)
  !> @param[in] arg Optional double precision real argument
  !> @param[in] val Value to compare
  !> @return .true. if arg is present and equals val within DP_EPS, .false. otherwise
  !> @enden
  !>
  !> @ja
  !> @brief arg が省略されておらず val と等しいかどうかを判定（倍精度版）
  !> @param[in] arg 省略可能な倍精度実数型引数
  !> @param[in] val 比較する値
  !> @return arg が省略されておらず DP_EPS 以内で val と等しい場合は .true.、それ以外は .false.
  !> @endja
  function present_and_eq_double(arg,val) result(result)
    logical                        :: result
    real(dp), intent(in), optional :: arg
    real(dp), intent(in)           :: val
    continue
    if(present(arg)) then
      if ( abs(arg - val) .le. dp_eps ) then
        result=.true.
      else
        result=.false.
      endif
    else
      result=.false.
    end if
  end function present_and_eq_double
  !> @en
  !> @brief Check if arg is present and not equals val (integer version)
  !> @param[in] arg Optional integer argument
  !> @param[in] val Value to compare
  !> @return .true. if arg is present and not equals val, .false. otherwise
  !> @enden
  !>
  !> @ja
  !> @brief arg が省略されておらず val と等しくないかどうかを判定（整数版）
  !> @param[in] arg 省略可能な整数型引数
  !> @param[in] val 比較する値
  !> @return arg が省略されておらず val と等しくない場合は .true.、それ以外は .false.
  !> @endja
  function present_and_ne_integer(arg,val) result(result)
    logical                       :: result
    integer, intent(in), optional :: arg
    integer, intent(in)           :: val
    continue
    result = .false.
    if(present(arg)) then
      if(arg/=val) then
        result=.true.
      else
        result=.false.
      endif
    else
      result=.false.
    endif
  end function present_and_ne_integer
  !> @en
  !> @brief Check if arg is present and not equals val (single precision version)
  !> @param[in] arg Optional single precision real argument
  !> @param[in] val Value to compare
  !> @return .true. if arg is present and not equals val beyond SP_EPS, .false. otherwise
  !> @enden
  !>
  !> @ja
  !> @brief arg が省略されておらず val と等しくないかどうかを判定（単精度版）
  !> @param[in] arg 省略可能な単精度実数型引数
  !> @param[in] val 比較する値
  !> @return arg が省略されておらず SP_EPS を超えて val と異なる場合は .true.、それ以外は .false.
  !> @endja
  function present_and_ne_real(arg,val) result(result)
    logical                        :: result
    real(sp), intent(in), optional :: arg
    real(sp), intent(in)           :: val
    continue
    result = .false.
    if(present(arg)) then
      if( abs(arg - val) .gt. sp_eps ) then
        result=.true.
      else
        result=.false.
      endif
    else
      result=.false.
    endif
  end function present_and_ne_real
  !> @en
  !> @brief Check if arg is present and not equals val (double precision version)
  !> @param[in] arg Optional double precision real argument
  !> @param[in] val Value to compare
  !> @return .true. if arg is present and not equals val beyond DP_EPS, .false. otherwise
  !> @enden
  !>
  !> @ja
  !> @brief arg が省略されておらず val と等しくないかどうかを判定（倍精度版）
  !> @param[in] arg 省略可能な倍精度実数型引数
  !> @param[in] val 比較する値
  !> @return arg が省略されておらず DP_EPS を超えて val と異なる場合は .true.、それ以外は .false.
  !> @endja
  function present_and_ne_double(arg,val) result(result)
    logical                        :: result
    real(dp), intent(in), optional :: arg
    real(dp), intent(in)           :: val
    continue
    result = .false.
    if(present(arg)) then
      if(abs(arg - val) .gt. dp_eps) then
        result=.true.
      else
        result=.false.
      endif
    else
      result=.false.
    endif
  end function present_and_ne_double
  !> @en
  !> @brief Check if arg is present and not empty string
  !> @param[in] arg Optional character argument
  !> @return .true. if arg is present and not an empty string, .false. otherwise
  !> @enden
  !>
  !> @ja
  !> @brief arg が省略されておらず空文字でないかどうかを判定
  !> @param[in] arg 省略可能な文字型引数
  !> @return arg が省略されておらず空文字でない場合は .true.、それ以外は .false.
  !> @endja
  function present_and_not_empty(arg) result(result)
    logical                                :: result
    character(len=*), intent(in), optional :: arg
    continue
    result = .false.
    if( present(arg) .AND. (arg .ne. '')) result = .true.
  end function present_and_not_empty
  !> @en
  !> @brief Select the first valid optional argument (Char version)
  !> @details
  !> Returns the first optional argument (c0-c9, i0-i9, r0-r9, or d0-d9) that is
  !> present and not equal to invalid. c0/i0/r0/d0 has the highest priority,
  !> c9/i9/r9/d9 has the lowest. If all optional arguments are absent or
  !> equal to invalid, default is returned.
  !> @param[in] invalid Value that marks an argument as invalid
  !> @param[in] default Default value to return if no valid argument found
  !> @return The first valid optional argument or default
  !> @enden
  !>
  !> @ja
  !> @brief 最初の有効な省略可能引数を選択（Char 版）
  !> @details
  !> 省略可能な引数 c0〜c9、i0〜i9、r0〜r9、d0〜d9 のうち、
  !> 省略されておらず、且つ invalid と等しくないものを1つ返します。
  !> c0/i0/r0/d0 の優先順位が最も高く、c9/i9/r9/d9 が最も低いです。
  !> 全ての引数が省略されているか invalid と等しい場合は default が返ります。
  !> @param[in] invalid 引数を無効とみなす値
  !> @param[in] default 有効な引数がない場合に返すデフォルト値
  !> @return 最初の有効な省略可能引数またはデフォルト値
  !> @endja
  function present_select_char(   &
    &  invalid, default,          &
    &  c0,c1,c2,c3,c4,c5,c6,c7,c8,c9 &
    &  ) result(result)
    implicit none
    character(*) ,intent(in)          :: invalid
    character(*) ,intent(in)          :: default
    character(*) ,intent(in),optional :: c0,c1,c2,c3,c4,c5,c6,c7,c8,c9
    character(STRING)                 :: result
    !=== Variables for internal work
    logical                           :: specified
    continue
    specified = .false.
    if ( present(c0) ) then
      if ( len(trim(c0)) > len(trim(invalid)) ) then
        result = c0
        specified = .true.
      else
        if ( trim(c0) /= invalid(:len(trim(c0))) ) then
          result = c0
          specified = .true.
        endif
      end if
    end if
    if ( present(c1) ) then
      if ( len(trim(c1)) > len(trim(invalid)) ) then
        result = c1
        specified = .true.
      else
        if ( trim(c1) /= invalid(:len(trim(c1))) ) then
          result = c1
          specified = .true.
        endif
      end if
    end if
    if ( present(c2) ) then
      if ( len(trim(c2)) > len(trim(invalid)) ) then
        result = c2
        specified = .true.
      else
        if ( trim(c2) /= invalid(:len(trim(c2))) ) then
          result = c2
          specified = .true.
        endif
      end if
    end if
    if ( present(c3) ) then
      if ( len(trim(c3)) > len(trim(invalid)) ) then
        result = c3
        specified = .true.
      else
        if ( trim(c3) /= invalid(:len(trim(c3))) ) then
          result = c3
          specified = .true.
        endif
      end if
    end if
    if ( present(c4) ) then
      if ( len(trim(c4)) > len(trim(invalid)) ) then
        result = c4
        specified = .true.
      else
        if ( trim(c4) /= invalid(:len(trim(c4))) ) then
          result = c4
          specified = .true.
        endif
      end if
    end if
    if ( present(c5) ) then
      if ( len(trim(c5)) > len(trim(invalid)) ) then
        result = c5
        specified = .true.
      else
        if ( trim(c5) /= invalid(:len(trim(c5))) ) then
          result = c5
          specified = .true.
        endif
      end if
    end if
    if ( present(c6) ) then
      if ( len(trim(c6)) > len(trim(invalid)) ) then
        result = c6
        specified = .true.
      else
        if ( trim(c6) /= invalid(:len(trim(c6))) ) then
          result = c6
          specified = .true.
        endif
      end if
    end if
    if ( present(c7) ) then
      if ( len(trim(c7)) > len(trim(invalid)) ) then
        result = c7
        specified = .true.
      else
        if ( trim(c7) /= invalid(:len(trim(c7))) ) then
          result = c7
          specified = .true.
        endif
      end if
    end if
    if ( present(c8) ) then
      if ( len(trim(c8)) > len(trim(invalid)) ) then
        result = c8
        specified = .true.
      else
        if ( trim(c8) /= invalid(:len(trim(c8))) ) then
          result = c8
          specified = .true.
        endif
      end if
    end if
    if ( present(c9) ) then
      if ( len(trim(c9)) > len(trim(invalid)) ) then
        result = c9
        specified = .true.
      else
        if ( trim(c9) /= invalid(:len(trim(c9))) ) then
          result = c9
          specified = .true.
        endif
      end if
    end if
    if (.not. specified) then
      result = default
    end if
  end function present_select_char
  !> @en
  !> @brief Select the first valid optional argument (Char_auto version)
  !> @details
  !> Returns the first optional argument (c0-c9, i0-i9, r0-r9, or d0-d9) that is
  !> present and not equal to invalid. c0/i0/r0/d0 has the highest priority,
  !> c9/i9/r9/d9 has the lowest. If all optional arguments are absent or
  !> equal to invalid, default is returned.
  !> @param[in] invalid Value that marks an argument as invalid
  !> @param[in] default Default value to return if no valid argument found
  !> @return The first valid optional argument or default
  !> @enden
  !>
  !> @ja
  !> @brief 最初の有効な省略可能引数を選択（Char_auto 版）
  !> @details
  !> 省略可能な引数 c0〜c9、i0〜i9、r0〜r9、d0〜d9 のうち、
  !> 省略されておらず、且つ invalid と等しくないものを1つ返します。
  !> c0/i0/r0/d0 の優先順位が最も高く、c9/i9/r9/d9 が最も低いです。
  !> 全ての引数が省略されているか invalid と等しい場合は default が返ります。
  !> @param[in] invalid 引数を無効とみなす値
  !> @param[in] default 有効な引数がない場合に返すデフォルト値
  !> @return 最初の有効な省略可能引数またはデフォルト値
  !> @endja
  function present_select_char_auto(   &
    &  invalid, default,          &
    &  c0,c1,c2,c3,c4,c5,c6,c7,c8,c9 &
    &  ) result(result)
    implicit none
    logical      ,intent(in)          :: invalid
    character(*) ,intent(in)          :: default
    character(*) ,intent(in),optional :: c0,c1,c2,c3,c4,c5,c6,c7,c8,c9
    character(STRING)                 :: result
    !=== Variables for internal work
    logical                           :: specified
    continue
    specified = .false.
    if ( invalid ) then
      ! no-op: keep argument referenced for -Wunused-dummy-argument
    end if
    if ( present(c0) ) then
       if ( trim(c0) /= '' ) then
          result = c0
          specified = .true.
       endif
    end if
    if ( invalid ) then
      ! no-op: keep argument referenced for -Wunused-dummy-argument
    end if
    if ( present(c1) ) then
       if ( trim(c1) /= '' ) then
          result = c1
          specified = .true.
       endif
    end if
    if ( invalid ) then
      ! no-op: keep argument referenced for -Wunused-dummy-argument
    end if
    if ( present(c2) ) then
       if ( trim(c2) /= '' ) then
          result = c2
          specified = .true.
       endif
    end if
    if ( invalid ) then
      ! no-op: keep argument referenced for -Wunused-dummy-argument
    end if
    if ( present(c3) ) then
       if ( trim(c3) /= '' ) then
          result = c3
          specified = .true.
       endif
    end if
    if ( invalid ) then
      ! no-op: keep argument referenced for -Wunused-dummy-argument
    end if
    if ( present(c4) ) then
       if ( trim(c4) /= '' ) then
          result = c4
          specified = .true.
       endif
    end if
    if ( invalid ) then
      ! no-op: keep argument referenced for -Wunused-dummy-argument
    end if
    if ( present(c5) ) then
       if ( trim(c5) /= '' ) then
          result = c5
          specified = .true.
       endif
    end if
    if ( invalid ) then
      ! no-op: keep argument referenced for -Wunused-dummy-argument
    end if
    if ( present(c6) ) then
       if ( trim(c6) /= '' ) then
          result = c6
          specified = .true.
       endif
    end if
    if ( invalid ) then
      ! no-op: keep argument referenced for -Wunused-dummy-argument
    end if
    if ( present(c7) ) then
       if ( trim(c7) /= '' ) then
          result = c7
          specified = .true.
       endif
    end if
    if ( invalid ) then
      ! no-op: keep argument referenced for -Wunused-dummy-argument
    end if
    if ( present(c8) ) then
       if ( trim(c8) /= '' ) then
          result = c8
          specified = .true.
       endif
    end if
    if ( invalid ) then
      ! no-op: keep argument referenced for -Wunused-dummy-argument
    end if
    if ( present(c9) ) then
       if ( trim(c9) /= '' ) then
          result = c9
          specified = .true.
       endif
    end if
    if (.not. specified) then
      result = default
    end if
  end function present_select_char_auto
  !> @en
  !> @brief Select the first valid optional argument (Int version)
  !> @details
  !> Returns the first optional argument (c0-c9, i0-i9, r0-r9, or d0-d9) that is
  !> present and not equal to invalid. c0/i0/r0/d0 has the highest priority,
  !> c9/i9/r9/d9 has the lowest. If all optional arguments are absent or
  !> equal to invalid, default is returned.
  !> @param[in] invalid Value that marks an argument as invalid
  !> @param[in] default Default value to return if no valid argument found
  !> @return The first valid optional argument or default
  !> @enden
  !>
  !> @ja
  !> @brief 最初の有効な省略可能引数を選択（Int 版）
  !> @details
  !> 省略可能な引数 c0〜c9、i0〜i9、r0〜r9、d0〜d9 のうち、
  !> 省略されておらず、且つ invalid と等しくないものを1つ返します。
  !> c0/i0/r0/d0 の優先順位が最も高く、c9/i9/r9/d9 が最も低いです。
  !> 全ての引数が省略されているか invalid と等しい場合は default が返ります。
  !> @param[in] invalid 引数を無効とみなす値
  !> @param[in] default 有効な引数がない場合に返すデフォルト値
  !> @return 最初の有効な省略可能引数またはデフォルト値
  !> @endja
  function present_select_int(   &
    &  invalid, default,          &
    &  i0,i1,i2,i3,i4,i5,i6,i7,i8,i9 &
    &  ) result(result)
    implicit none
    integer      ,intent(in)          :: invalid
    integer      ,intent(in)          :: default
    integer      ,intent(in),optional :: i0,i1,i2,i3,i4,i5,i6,i7,i8,i9
    integer                           :: result
    !=== Variables for internal work
    logical                           :: specified
    continue
    specified = .false.
    if ( present(i0) ) then
      if ( i0 /= invalid ) then
        result = i0
        specified = .true.
      endif
    end if
    if ( present(i1) ) then
      if ( i1 /= invalid ) then
        result = i1
        specified = .true.
      endif
    end if
    if ( present(i2) ) then
      if ( i2 /= invalid ) then
        result = i2
        specified = .true.
      endif
    end if
    if ( present(i3) ) then
      if ( i3 /= invalid ) then
        result = i3
        specified = .true.
      endif
    end if
    if ( present(i4) ) then
      if ( i4 /= invalid ) then
        result = i4
        specified = .true.
      endif
    end if
    if ( present(i5) ) then
      if ( i5 /= invalid ) then
        result = i5
        specified = .true.
      endif
    end if
    if ( present(i6) ) then
      if ( i6 /= invalid ) then
        result = i6
        specified = .true.
      endif
    end if
    if ( present(i7) ) then
      if ( i7 /= invalid ) then
        result = i7
        specified = .true.
      endif
    end if
    if ( present(i8) ) then
      if ( i8 /= invalid ) then
        result = i8
        specified = .true.
      endif
    end if
    if ( present(i9) ) then
      if ( i9 /= invalid ) then
        result = i9
        specified = .true.
      endif
    end if
    if (.not. specified) then
      result = default
    end if
  end function present_select_int
  !> @en
  !> @brief Select the first valid optional argument (Int_auto version)
  !> @details
  !> Returns the first optional argument (c0-c9, i0-i9, r0-r9, or d0-d9) that is
  !> present and not equal to invalid. c0/i0/r0/d0 has the highest priority,
  !> c9/i9/r9/d9 has the lowest. If all optional arguments are absent or
  !> equal to invalid, default is returned.
  !> @param[in] invalid Value that marks an argument as invalid
  !> @param[in] default Default value to return if no valid argument found
  !> @return The first valid optional argument or default
  !> @enden
  !>
  !> @ja
  !> @brief 最初の有効な省略可能引数を選択（Int_auto 版）
  !> @details
  !> 省略可能な引数 c0〜c9、i0〜i9、r0〜r9、d0〜d9 のうち、
  !> 省略されておらず、且つ invalid と等しくないものを1つ返します。
  !> c0/i0/r0/d0 の優先順位が最も高く、c9/i9/r9/d9 が最も低いです。
  !> 全ての引数が省略されているか invalid と等しい場合は default が返ります。
  !> @param[in] invalid 引数を無効とみなす値
  !> @param[in] default 有効な引数がない場合に返すデフォルト値
  !> @return 最初の有効な省略可能引数またはデフォルト値
  !> @endja
  function present_select_int_auto(   &
    &  invalid, default,          &
    &  i0,i1,i2,i3,i4,i5,i6,i7,i8,i9 &
    &  ) result(result)
    implicit none
    logical      ,intent(in)          :: invalid
    integer      ,intent(in)          :: default
    integer      ,intent(in),optional :: i0,i1,i2,i3,i4,i5,i6,i7,i8,i9
    integer                           :: result
    !=== Variables for internal work
    logical                           :: specified
    continue
    specified = .false.
    if ( present(i0) ) then
      if ( .not. invalid ) then
        result = i0
        specified = .true.
      elseif ( i0 .ne. 0 ) then
        result = i0
        specified = .true.
      end if
    end if
    if ( present(i1) ) then
      if ( .not. invalid ) then
        result = i1
        specified = .true.
      elseif ( i1 .ne. 0 ) then
        result = i1
        specified = .true.
      end if
    end if
    if ( present(i2) ) then
      if ( .not. invalid ) then
        result = i2
        specified = .true.
      elseif ( i2 .ne. 0 ) then
        result = i2
        specified = .true.
      end if
    end if
    if ( present(i3) ) then
      if ( .not. invalid ) then
        result = i3
        specified = .true.
      elseif ( i3 .ne. 0 ) then
        result = i3
        specified = .true.
      end if
    end if
    if ( present(i4) ) then
      if ( .not. invalid ) then
        result = i4
        specified = .true.
      elseif ( i4 .ne. 0 ) then
        result = i4
        specified = .true.
      end if
    end if
    if ( present(i5) ) then
      if ( .not. invalid ) then
        result = i5
        specified = .true.
      elseif ( i5 .ne. 0 ) then
        result = i5
        specified = .true.
      end if
    end if
    if ( present(i6) ) then
      if ( .not. invalid ) then
        result = i6
        specified = .true.
      elseif ( i6 .ne. 0 ) then
        result = i6
        specified = .true.
      end if
    end if
    if ( present(i7) ) then
      if ( .not. invalid ) then
        result = i7
        specified = .true.
      elseif ( i7 .ne. 0 ) then
        result = i7
        specified = .true.
      end if
    end if
    if ( present(i8) ) then
      if ( .not. invalid ) then
        result = i8
        specified = .true.
      elseif ( i8 .ne. 0 ) then
        result = i8
        specified = .true.
      end if
    end if
    if ( present(i9) ) then
      if ( .not. invalid ) then
        result = i9
        specified = .true.
      elseif ( i9 .ne. 0 ) then
        result = i9
        specified = .true.
      end if
    end if
    if (.not. specified) then
      result = default
    end if
  end function present_select_int_auto
  !> @en
  !> @brief Select the first valid optional argument (Real version)
  !> @details
  !> Returns the first optional argument (c0-c9, i0-i9, r0-r9, or d0-d9) that is
  !> present and not equal to invalid. c0/i0/r0/d0 has the highest priority,
  !> c9/i9/r9/d9 has the lowest. If all optional arguments are absent or
  !> equal to invalid, default is returned.
  !> @param[in] invalid Value that marks an argument as invalid
  !> @param[in] default Default value to return if no valid argument found
  !> @return The first valid optional argument or default
  !> @enden
  !>
  !> @ja
  !> @brief 最初の有効な省略可能引数を選択（Real 版）
  !> @details
  !> 省略可能な引数 c0〜c9、i0〜i9、r0〜r9、d0〜d9 のうち、
  !> 省略されておらず、且つ invalid と等しくないものを1つ返します。
  !> c0/i0/r0/d0 の優先順位が最も高く、c9/i9/r9/d9 が最も低いです。
  !> 全ての引数が省略されているか invalid と等しい場合は default が返ります。
  !> @param[in] invalid 引数を無効とみなす値
  !> @param[in] default 有効な引数がない場合に返すデフォルト値
  !> @return 最初の有効な省略可能引数またはデフォルト値
  !> @endja
  function present_select_real(   &
    &  invalid, default,          &
    &  r0,r1,r2,r3,r4,r5,r6,r7,r8,r9 &
    &  ) result(result)
    implicit none
    real(sp)     ,intent(in)          :: invalid
    real(sp)     ,intent(in)          :: default
    real(sp)     ,intent(in),optional :: r0,r1,r2,r3,r4,r5,r6,r7,r8,r9
    real(sp)                          :: result
    !=== Variables for internal work
    logical                           :: specified
    continue
    specified = .false.
    if ( present(r0) ) then
      if ( abs(r0 - invalid) .gt. sp_eps ) then
        result = r0
        specified = .true.
      endif
    end if
    if ( present(r1) ) then
      if ( abs(r1 - invalid) .gt. sp_eps ) then
        result = r1
        specified = .true.
      endif
    end if
    if ( present(r2) ) then
      if ( abs(r2 - invalid) .gt. sp_eps ) then
        result = r2
        specified = .true.
      endif
    end if
    if ( present(r3) ) then
      if ( abs(r3 - invalid) .gt. sp_eps ) then
        result = r3
        specified = .true.
      endif
    end if
    if ( present(r4) ) then
      if ( abs(r4 - invalid) .gt. sp_eps ) then
        result = r4
        specified = .true.
      endif
    end if
    if ( present(r5) ) then
      if ( abs(r5 - invalid) .gt. sp_eps ) then
        result = r5
        specified = .true.
      endif
    end if
    if ( present(r6) ) then
      if ( abs(r6 - invalid) .gt. sp_eps ) then
        result = r6
        specified = .true.
      endif
    end if
    if ( present(r7) ) then
      if ( abs(r7 - invalid) .gt. sp_eps ) then
        result = r7
        specified = .true.
      endif
    end if
    if ( present(r8) ) then
      if ( abs(r8 - invalid) .gt. sp_eps ) then
        result = r8
        specified = .true.
      endif
    end if
    if ( present(r9) ) then
      if ( abs(r9 - invalid) .gt. sp_eps ) then
        result = r9
        specified = .true.
      endif
    end if
    if (.not. specified) then
      result = default
    end if
  end function present_select_real
  !> @en
  !> @brief Select the first valid optional argument (Real_auto version)
  !> @details
  !> Returns the first optional argument (c0-c9, i0-i9, r0-r9, or d0-d9) that is
  !> present and not equal to invalid. c0/i0/r0/d0 has the highest priority,
  !> c9/i9/r9/d9 has the lowest. If all optional arguments are absent or
  !> equal to invalid, default is returned.
  !> @param[in] invalid Value that marks an argument as invalid
  !> @param[in] default Default value to return if no valid argument found
  !> @return The first valid optional argument or default
  !> @enden
  !>
  !> @ja
  !> @brief 最初の有効な省略可能引数を選択（Real_auto 版）
  !> @details
  !> 省略可能な引数 c0〜c9、i0〜i9、r0〜r9、d0〜d9 のうち、
  !> 省略されておらず、且つ invalid と等しくないものを1つ返します。
  !> c0/i0/r0/d0 の優先順位が最も高く、c9/i9/r9/d9 が最も低いです。
  !> 全ての引数が省略されているか invalid と等しい場合は default が返ります。
  !> @param[in] invalid 引数を無効とみなす値
  !> @param[in] default 有効な引数がない場合に返すデフォルト値
  !> @return 最初の有効な省略可能引数またはデフォルト値
  !> @endja
  function present_select_real_auto(   &
    &  invalid, default,          &
    &  r0,r1,r2,r3,r4,r5,r6,r7,r8,r9 &
    &  ) result(result)
    implicit none
    logical      ,intent(in)          :: invalid
    real(sp)     ,intent(in)          :: default
    real(sp)     ,intent(in),optional :: r0,r1,r2,r3,r4,r5,r6,r7,r8,r9
    real(sp)                          :: result
    !=== Variables for internal work
    logical                           :: specified
    continue
    specified = .false.
    if ( present(r0) ) then
      if ( .not. invalid ) then
        result = r0
        specified = .true.
      elseif ( abs(r0 - 0.0_dp) .lt. sp_eps) then
        result = r0
        specified = .true.
      endif
    end if
    if ( present(r1) ) then
      if ( .not. invalid ) then
        result = r1
        specified = .true.
      elseif ( abs(r1 - 0.0_dp) .lt. sp_eps) then
        result = r1
        specified = .true.
      endif
    end if
    if ( present(r2) ) then
      if ( .not. invalid ) then
        result = r2
        specified = .true.
      elseif ( abs(r2 - 0.0_dp) .lt. sp_eps) then
        result = r2
        specified = .true.
      endif
    end if
    if ( present(r3) ) then
      if ( .not. invalid ) then
        result = r3
        specified = .true.
      elseif ( abs(r3 - 0.0_dp) .lt. sp_eps) then
        result = r3
        specified = .true.
      endif
    end if
    if ( present(r4) ) then
      if ( .not. invalid ) then
        result = r4
        specified = .true.
      elseif ( abs(r4 - 0.0_dp) .lt. sp_eps) then
        result = r4
        specified = .true.
      endif
    end if
    if ( present(r5) ) then
      if ( .not. invalid ) then
        result = r5
        specified = .true.
      elseif ( abs(r5 - 0.0_dp) .lt. sp_eps) then
        result = r5
        specified = .true.
      endif
    end if
    if ( present(r6) ) then
      if ( .not. invalid ) then
        result = r6
        specified = .true.
      elseif ( abs(r6 - 0.0_dp) .lt. sp_eps) then
        result = r6
        specified = .true.
      endif
    end if
    if ( present(r7) ) then
      if ( .not. invalid ) then
        result = r7
        specified = .true.
      elseif ( abs(r7 - 0.0_dp) .lt. sp_eps) then
        result = r7
        specified = .true.
      endif
    end if
    if ( present(r8) ) then
      if ( .not. invalid ) then
        result = r8
        specified = .true.
      elseif ( abs(r8 - 0.0_dp) .lt. sp_eps) then
        result = r8
        specified = .true.
      endif
    end if
    if ( present(r9) ) then
      if ( .not. invalid ) then
        result = r9
        specified = .true.
      elseif ( abs(r9 - 0.0_dp) .lt. sp_eps) then
        result = r9
        specified = .true.
      endif
    end if
    if (.not. specified) then
      result = default
    end if
  end function present_select_real_auto
  !> @en
  !> @brief Select the first valid optional argument (Double version)
  !> @details
  !> Returns the first optional argument (c0-c9, i0-i9, r0-r9, or d0-d9) that is
  !> present and not equal to invalid. c0/i0/r0/d0 has the highest priority,
  !> c9/i9/r9/d9 has the lowest. If all optional arguments are absent or
  !> equal to invalid, default is returned.
  !> @param[in] invalid Value that marks an argument as invalid
  !> @param[in] default Default value to return if no valid argument found
  !> @return The first valid optional argument or default
  !> @enden
  !>
  !> @ja
  !> @brief 最初の有効な省略可能引数を選択（Double 版）
  !> @details
  !> 省略可能な引数 c0〜c9、i0〜i9、r0〜r9、d0〜d9 のうち、
  !> 省略されておらず、且つ invalid と等しくないものを1つ返します。
  !> c0/i0/r0/d0 の優先順位が最も高く、c9/i9/r9/d9 が最も低いです。
  !> 全ての引数が省略されているか invalid と等しい場合は default が返ります。
  !> @param[in] invalid 引数を無効とみなす値
  !> @param[in] default 有効な引数がない場合に返すデフォルト値
  !> @return 最初の有効な省略可能引数またはデフォルト値
  !> @endja
  function present_select_double(   &
    &  invalid, default,          &
    &  d0,d1,d2,d3,d4,d5,d6,d7,d8,d9 &
    &  ) result(result)
    implicit none
    real(dp)     ,intent(in)          :: invalid
    real(dp)     ,intent(in)          :: default
    real(dp)     ,intent(in),optional :: d0,d1,d2,d3,d4,d5,d6,d7,d8,d9
    real(dp)                          :: result
    !=== Variables for internal work
    logical                           :: specified
    continue
    specified = .false.
    if ( present(d0) ) then
      if ( abs(d0  - invalid) .gt. dp_eps ) then
        result = d0
        specified = .true.
      endif
    end if
    if ( present(d1) ) then
      if ( abs(d1  - invalid) .gt. dp_eps ) then
        result = d1
        specified = .true.
      endif
    end if
    if ( present(d2) ) then
      if ( abs(d2  - invalid) .gt. dp_eps ) then
        result = d2
        specified = .true.
      endif
    end if
    if ( present(d3) ) then
      if ( abs(d3  - invalid) .gt. dp_eps ) then
        result = d3
        specified = .true.
      endif
    end if
    if ( present(d4) ) then
      if ( abs(d4  - invalid) .gt. dp_eps ) then
        result = d4
        specified = .true.
      endif
    end if
    if ( present(d5) ) then
      if ( abs(d5  - invalid) .gt. dp_eps ) then
        result = d5
        specified = .true.
      endif
    end if
    if ( present(d6) ) then
      if ( abs(d6  - invalid) .gt. dp_eps ) then
        result = d6
        specified = .true.
      endif
    end if
    if ( present(d7) ) then
      if ( abs(d7  - invalid) .gt. dp_eps ) then
        result = d7
        specified = .true.
      endif
    end if
    if ( present(d8) ) then
      if ( abs(d8  - invalid) .gt. dp_eps ) then
        result = d8
        specified = .true.
      endif
    end if
    if ( present(d9) ) then
      if ( abs(d9  - invalid) .gt. dp_eps ) then
        result = d9
        specified = .true.
      endif
    end if
    if (.not. specified) then
      result = default
    end if
  end function present_select_double
  !> @en
  !> @brief Select the first valid optional argument (Double_auto version)
  !> @details
  !> Returns the first optional argument (c0-c9, i0-i9, r0-r9, or d0-d9) that is
  !> present and not equal to invalid. c0/i0/r0/d0 has the highest priority,
  !> c9/i9/r9/d9 has the lowest. If all optional arguments are absent or
  !> equal to invalid, default is returned.
  !> @param[in] invalid Value that marks an argument as invalid
  !> @param[in] default Default value to return if no valid argument found
  !> @return The first valid optional argument or default
  !> @enden
  !>
  !> @ja
  !> @brief 最初の有効な省略可能引数を選択（Double_auto 版）
  !> @details
  !> 省略可能な引数 c0〜c9、i0〜i9、r0〜r9、d0〜d9 のうち、
  !> 省略されておらず、且つ invalid と等しくないものを1つ返します。
  !> c0/i0/r0/d0 の優先順位が最も高く、c9/i9/r9/d9 が最も低いです。
  !> 全ての引数が省略されているか invalid と等しい場合は default が返ります。
  !> @param[in] invalid 引数を無効とみなす値
  !> @param[in] default 有効な引数がない場合に返すデフォルト値
  !> @return 最初の有効な省略可能引数またはデフォルト値
  !> @endja
  function present_select_double_auto(   &
    &  invalid, default,          &
    &  d0,d1,d2,d3,d4,d5,d6,d7,d8,d9 &
    &  ) result(result)
    implicit none
    logical      ,intent(in)          :: invalid
    real(dp)     ,intent(in)          :: default
    real(dp)     ,intent(in),optional :: d0,d1,d2,d3,d4,d5,d6,d7,d8,d9
    real(dp)                          :: result
    !=== Variables for internal work
    logical                           :: specified
    continue
    specified = .false.
    if ( present(d0) ) then
      if ( .not. invalid ) then
        result = d0
        specified = .true.
      elseif ( abs(d0 - 0.0_dp) .lt. dp_eps) then
        result = d0
        specified = .true.
      endif
    end if
    if ( present(d1) ) then
      if ( .not. invalid ) then
        result = d1
        specified = .true.
      elseif ( abs(d1 - 0.0_dp) .lt. dp_eps) then
        result = d1
        specified = .true.
      endif
    end if
    if ( present(d2) ) then
      if ( .not. invalid ) then
        result = d2
        specified = .true.
      elseif ( abs(d2 - 0.0_dp) .lt. dp_eps) then
        result = d2
        specified = .true.
      endif
    end if
    if ( present(d3) ) then
      if ( .not. invalid ) then
        result = d3
        specified = .true.
      elseif ( abs(d3 - 0.0_dp) .lt. dp_eps) then
        result = d3
        specified = .true.
      endif
    end if
    if ( present(d4) ) then
      if ( .not. invalid ) then
        result = d4
        specified = .true.
      elseif ( abs(d4 - 0.0_dp) .lt. dp_eps) then
        result = d4
        specified = .true.
      endif
    end if
    if ( present(d5) ) then
      if ( .not. invalid ) then
        result = d5
        specified = .true.
      elseif ( abs(d5 - 0.0_dp) .lt. dp_eps) then
        result = d5
        specified = .true.
      endif
    end if
    if ( present(d6) ) then
      if ( .not. invalid ) then
        result = d6
        specified = .true.
      elseif ( abs(d6 - 0.0_dp) .lt. dp_eps) then
        result = d6
        specified = .true.
      endif
    end if
    if ( present(d7) ) then
      if ( .not. invalid ) then
        result = d7
        specified = .true.
      elseif ( abs(d7 - 0.0_dp) .lt. dp_eps) then
        result = d7
        specified = .true.
      endif
    end if
    if ( present(d8) ) then
      if ( .not. invalid ) then
        result = d8
        specified = .true.
      elseif ( abs(d8 - 0.0_dp) .lt. dp_eps) then
        result = d8
        specified = .true.
      endif
    end if
    if ( present(d9) ) then
      if ( .not. invalid ) then
        result = d9
        specified = .true.
      elseif ( abs(d9 - 0.0_dp) .lt. dp_eps) then
        result = d9
        specified = .true.
      endif
    end if
    if (.not. specified) then
      result = default
    end if
  end function present_select_double_auto
  !> @namespace dc_present
end module dc_present