/usr/include/genometools/core/range_api.h is in libgenometools0-dev 1.5.9+ds-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | /*
Copyright (c) 2005-2009 Gordon Gremme <gordon@gremme.org>
Copyright (c) 2005-2008 Center for Bioinformatics, University of Hamburg
Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
#ifndef RANGE_API_H
#define RANGE_API_H
#include <stdbool.h>
#include "core/array_api.h"
/* The <GtRange> class is used to represent genomic ranges in __GenomeTools__.
Thereby, the <start> must ___always___ be smaller or equal than the <end>. */
typedef struct GtRange GtRange;
struct GtRange {
GtUword start,
end;
};
/* Compare <range_a> and <range_b>. Returns 0 if <range_a> equals <range_b>, -1
if <range_a> starts before <range_b> or (for equal starts) <range_a> ends
before <range_b>, and 1 else. */
int gt_range_compare(const GtRange *range_a, const GtRange *range_b);
/* Compare <range_a> and <range_b> with given <delta>.
Returns 0 if <range_a> equals <range_b> modulo <delta> (i.e., the start and
end points of <range_a> and <range_b> are at most <delta> bases apart), -1
if <range_a> starts before <range_b> or (for equal starts) <range_a> ends
before <range_b>, and 1 else. */
int gt_range_compare_with_delta(const GtRange *range_a,
const GtRange *range_b,
GtUword delta);
/* Returns <true> if <range_a> and <range_b> overlap, <false> otherwise. */
bool gt_range_overlap(const GtRange *range_a, const GtRange *range_b);
/* Returns <true> if <range_a> and <range_b> overlap ___at least___ <delta> many
positions, <false> otherwise. */
bool gt_range_overlap_delta(const GtRange *range_a,
const GtRange *range_b,
GtUword delta);
/* Returns <true> if <range_b> is contained in <range_a>, <false> otherwise. */
bool gt_range_contains(const GtRange *range_a, const GtRange *range_b);
/* Returns <true> if <point> lies within <range>, <false> otherwise. */
bool gt_range_within(const GtRange *range, GtUword point);
/* Join <range_a> and <range_b> and return the result. */
GtRange gt_range_join(const GtRange *range_a, const GtRange *range_b);
/* Transform start and end of <range> by <offset> and return the result. */
GtRange gt_range_offset(const GtRange *range, GtWord offset);
/* Returns the length of the given <range>. */
GtUword gt_range_length(const GtRange *range);
#endif
|