PK_ENTITY_range_r_t

struct PK_ENTITY_range_r_s
    {
    int                    r_t_version; --- version number of return structure
    int                    n_results;   --- number of ranges
    PK_range_result_t     *results;     --- range status array
    double                *distances;   --- distance array
    PK_ENTITY_range_end_t *ends_1;      --- end positions array
    PK_ENTITY_range_end_t *ends_2;      --- end positions array
    };
typedef struct PK_ENTITY_range_r_s PK_ENTITY_range_r_t;


A structure packaging the result from PK_ENTITY_range

Used in:

PK_ENTITY_range
PK_ENTITY_range_r_f

The solutions are returned in separate arrays whose corresponding entries
provide the range information calculated.

The function returns 'results' array which elements can be one of four values:
   PK_range_result_found_c      the separation has been successfully found.
   PK_range_result_lower_c      minimum/maximum distance does not satisfy the
                                supplied lower bound.
   PK_range_result_upper_c      minimum/maximum distance does not satisfy the
                                supplied upper bound.
   PK_range_result_not_found_c  the identification of the separation failed

If the 'results' value is equal to PK_range_result_found_c, then range data
will also be returned. This consists of a double array 'distances', which is
the separation distance, and two structure arrays ('ends_1' and ends_2') of
type PK_ENTITY_range_end_t, which provide information on each end of the line
of separation.

The function PK_ENTITY_range_r_f may be used to free associated memory.