/*
  Copyright (c) 2007, 2009 Gordon Gremme <gordon@gremme.org>
  Copyright (c) 2004       Stefan Kurtz <kurtz@zbh.uni-hamburg.de>
  Copyright (c) 2004, 2007 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 GLOBALCHAINING_API_H
#define GLOBALCHAINING_API_H

#include "core/error_api.h"
#include "extended/chain_api.h"

/* GlobalChaining module */

typedef struct {
  GtUword startpos1, /* start of fragment in first sequence */
                endpos1,   /* end of fragment in first sequence */
                startpos2, /* start of fragment in second sequence */
                endpos2;   /* end of fragment in second sequence */
  GtWord weight;           /* weight of fragment */
  void *data;              /* arbitrary data associated with fragment */
} GtFragment;

/* Function to process a chain. <frags> is an array of <GtFragment>s,
   of size <num_of_fragments>. <max_gap_width> and <cpinfo> are passed from
   the <gt_globalchaining_*()> calls. */
typedef void (*GtChainProc)(GtChain *c, GtFragment *frags,
                            GtUword num_of_fragments,
                            GtUword max_gap_width, void *cpinfo);

/* Perform global chaining with overlaps of <num_of_fragments> many <fragments>
   in quadratic time w.r.t. <num_of_fragments>.
   Two fragments can maximally be <max_gap_width> many bases away.
   For all global chains of maximal score, the GtChainProc function is called.
   Thereby, GtChainProc does not get the ownership of the GtChain. */
void gt_globalchaining_max(GtFragment *fragments,
                           GtUword num_of_fragments,
                           GtUword max_gap_width, GtChainProc,
                           void *cpinfo);

/* Perform global chaining with overlaps of <num_of_fragments> many <fragments>
   in quadratic time w.r.t. <num_of_fragments>.
   Two fragments can maximally be <max_gap_width> many bases away.
   For all non-overlapping global chains with a coverage of more then
   <mincoverage> of the sequence in dimension 1 (with length <seqlen1>), the
   GtChainProc function is called. Thereby, GtChainProc does not get the
   ownership of the GtChain. */
void gt_globalchaining_coverage(GtFragment *fragments,
                                GtUword num_of_fragments,
                                GtUword max_gap_width,
                                GtUword seqlen1, double mincoverage,
                                GtChainProc, void *cpinfo);

#endif
