H.1.6 Get Value Monomial Functions

The main documentation of the Get Value Monomial Functions contains additional explanation of this code listing.

  define([CHARACTER_ACCESS_ROUTINE],[
    pushdef([VALUE], [$1])
    pushdef([VALUE_Result], expand(VALUE_Result))
    pushdef([Get_CHARACTER_VALUE_Monomial], expand(Get_VALUE_Monomial))

    function Get_CHARACTER_VALUE_Monomial (Monomial) result(VALUE_Result)
  
      ! Input variables.

      type(Monomial_type), intent(in) :: Monomial   ! Monomial object.
  
      ! Output variables.
  
      type(character,80) :: VALUE_Result         ! Monomial value to be output.
  
      !~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  
      ! Verify requirements.
  
      VERIFY(Valid_State(Monomial),5)               ! Monomial is valid.
  
      ! Set value.
  
      VALUE_Result = Monomial%Value

      ! Verify guarantees - none.
  
      return
    end function Get_CHARACTER_VALUE_Monomial

    popdef([VALUE])
    popdef([VALUE_Result])
    popdef([Get_CHARACTER_VALUE_Monomial])
  ])

  fortext([Value],
          [Locus Name],[
    CHARACTER_ACCESS_ROUTINE(Value)
  ])