xt_idxlist.h

Go to the documentation of this file.

/*
 * Keywords:
 * Maintainer: Jörg Behrens <behrens@dkrz.de>
 *             Moritz Hanke <hanke@dkrz.de>
 *             Thomas Jahns <jahns@dkrz.de>
 * URL: https://doc.redmine.dkrz.de/yaxt/html/
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are  permitted provided that the following conditions are
 * met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the name of the DKRZ GmbH nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef XT_IDXLIST_H
#define XT_IDXLIST_H

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <stdlib.h>
#include "xt/xt_core.h"
#include "xt/xt_stripe.h"

struct Xt_bounds {
   Xt_int start, size;
};

void xt_idxlist_delete(Xt_idxlist idxlist);

size_t xt_idxlist_get_pack_size(Xt_idxlist idxlist, MPI_Comm comm);

void xt_idxlist_pack(Xt_idxlist idxlist, void* buffer, int buffer_size,
                     int* position, MPI_Comm comm);

Xt_idxlist xt_idxlist_unpack(void* buffer, int buffer_size,
                             int* position, MPI_Comm comm);

Xt_idxlist
xt_idxlist_get_intersection(Xt_idxlist idxlist_src, Xt_idxlist idxlist_dst);

Xt_idxlist xt_idxlist_copy(Xt_idxlist idxlist);

int xt_idxlist_get_num_indices(Xt_idxlist idxlist);

void xt_idxlist_get_indices(Xt_idxlist idxlist, Xt_int *indices);

const Xt_int *xt_idxlist_get_indices_const(Xt_idxlist idxlist);

void xt_idxlist_get_index_stripes(Xt_idxlist idxlist,
                                  struct Xt_stripe **stripes,
                                  int *num_stripes);

int xt_idxlist_get_index_at_position(Xt_idxlist idxlist, int position,
                                     Xt_int * index);

int xt_idxlist_get_indices_at_positions(Xt_idxlist idxlist,
                                        const int *positions,
                                        int num_pos, Xt_int *indices,
                                        Xt_int undef_idx);

int xt_idxlist_get_position_of_index(Xt_idxlist idxlist, Xt_int index,
                                     int *position);

int xt_idxlist_get_positions_of_indices(Xt_idxlist idxlist,
                                        const Xt_int *indices,
                                        int num_indices, int *positions,
                                        int single_match_only);

int xt_idxlist_get_pos_exts_of_index_stripes(
  Xt_idxlist idxlist,
  int num_stripes,
  const struct Xt_stripe stripes[num_stripes],
  int *num_ext,
  struct Xt_pos_ext **pos_ext,
  int single_match_only);


int xt_idxlist_get_position_of_index_off(Xt_idxlist idxlist, Xt_int index,
                                         int * position, int offset);

/* FIXME: this should probably return the number of failed lookups */
int xt_idxlist_get_positions_of_indices_off(Xt_idxlist idxlist,
                                            const Xt_int *indices,
                                            int num_indices, int * positions,
                                            int * offsets);

Xt_int xt_idxlist_get_min_index(Xt_idxlist idxlist);

Xt_int xt_idxlist_get_max_index(Xt_idxlist idxlist);

void xt_idxlist_get_bounding_box(Xt_idxlist idxlist, unsigned ndim,
                                 const Xt_int global_size[ndim],
                                 Xt_int global_start_index,
                                 struct Xt_bounds bounds[ndim]);

Xt_uid xt_idxlist_get_uid(Xt_idxlist idxlist);

#endif // XT_IDXLIST_H

/*
 * Local Variables:
 * c-basic-offset: 2
 * coding: utf-8
 * indent-tabs-mode: nil
 * show-trailing-whitespace: t
 * require-trailing-newline: t
 * End:
 */