fdoc_generics.f90

modulefdoc_generics

The overview of a generic interface: which ways there are to call it, and which types and ranks each one takes. Specific procedures with the same arguments make a call form, and each form gets a table with a row for each combination of types and a column for each rank. Types are compared as written, so two names of one kind count as different types. Pages are rendered in parallel, so nothing here calls a function returning a deferred-length string (see example/slen_race.f90).

Uses

Graphs

Uses

Used by

Variables

Name	Type	Attributes	Default	Description
ANY_RANK	integer	privateparameter	-1	the rank of an assumed-rank argument

Functions

is_elementalpureprivate

pure logical function is_elemental(e)

True if procedure e is elemental.

rank_ofpureprivate

pure integer function rank_of(dimension)

The rank given by dimension, such as (:,:): one more than the commas outside inner parentheses.

Subroutines

argument_nameprivate

subroutine argument_name(list, id, name)

The name of argument id.

call_textprivate

subroutine call_text(list, name, id, has_result, b)

Write how a call of a form looks. Square brackets mark what is optional.

describeprivate

subroutine describe(list, id, text, rank)

The text and rank of the type of variable id. Anything else, such as a dummy procedure, is procedure.

form_keyprivate

subroutine form_key(list, id, key)

What specific procedure id has in common with those of its call form.

label_resultsprivate

subroutine label_results(ranks, primary, relative, types, result_ranks, labels)

The text of each result.

rank_labelprivate

subroutine rank_label(text, rank, in_columns, tied, relative, offset, label)

The text of type text with its rank. A rank in columns is left out, and a tied one is relative.

shared_summaryprivate

subroutine shared_summary(list, ids, b)

Write the summary of the procedures ids, if they all have the same one.

sort_intspureprivate

pure subroutine sort_ints(list)

Put list in order.

specific_linkprivate

subroutine specific_link(list, id, text, b)

Write a link to specific procedure id, further down the page.

write_call_forms

subroutine write_call_forms(list, name, specifics, b, shown)

Write the call forms of generic name, if it has more than one specific procedure. shown says whether anything was written.

write_formprivate

subroutine write_form(list, name, ids, b)

Write one call form, whose specific procedures are ids.