/usr/include/ncbi-vdb/kfs/arrayfile.h is in libncbi-vdb-dev 2.8.1+dfsg-2.
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 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 | /*===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's official duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
*/
#ifndef _h_kfs_arrayfile_
#define _h_kfs_arrayfile_
#ifndef _h_kfs_extern_
#include <kfs/extern.h>
#endif
#ifndef _h_klib_defs_
#include <klib/defs.h>
#endif
#ifndef _h_klib_namelist_
#include <klib/namelist.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*--------------------------------------------------------------------------
* forwards
*/
struct KFile;
/*--------------------------------------------------------------------------
* KArrayFile
* an array-file is created from a KFile
*/
typedef struct KArrayFile KArrayFile;
/* Make
* make an array file from a KFile
*/
/*
KFS_EXTERN rc_t CC KArrayFileMakeRead ( const KArrayFile **af, struct KFile const *file );
KFS_EXTERN rc_t CC KArrayFileMakeUpdate ( KArrayFile **af, struct KFile *file );
*/
/* AddRef
* Release
* ignores NULL references
*/
KFS_EXTERN rc_t CC KArrayFileAddRef ( const KArrayFile *self );
KFS_EXTERN rc_t CC KArrayFileRelease ( const KArrayFile *self );
/* Dimensionality
* returns the number of dimensions in the ArrayFile
*
* "dim" [ OUT ] - return parameter for number of dimensions
*/
KFS_EXTERN rc_t CC KArrayFileDimensionality ( const KArrayFile *self, uint8_t *dim );
/* SetDimensionality
* sets the number of dimensions in the ArrayFile
*
* "dim" [ IN ] - new number of dimensions; must be > 0
*/
KFS_EXTERN rc_t CC KArrayFileSetDimensionality ( KArrayFile *self, uint8_t dim );
/* DimExtents
* returns the extent of every dimension
*
* "dim" [ IN ] - the dimensionality of "extents"
*
* "extents" [ OUT ] - returns the extent for every dimension
*/
KFS_EXTERN rc_t CC KArrayFileDimExtents ( const KArrayFile *self, uint8_t dim, uint64_t *extents );
/* SetDimExtents
* sets the new extents for every dimension
*
* "dim" [ IN ] - the dimensionality of "extents"
*
* "extents" [ IN ] - new extents for every dimension
*/
KFS_EXTERN rc_t CC KArrayFileSetDimExtents ( KArrayFile *self, uint8_t dim, uint64_t *extents );
/* ElementSize
* returns the element size in bits
*
* "elem_bits" [ OUT ] - size of each element in bits
*/
KFS_EXTERN rc_t CC KArrayFileElementSize ( const KArrayFile *self, uint64_t *elem_bits );
/* Read
* read from n-dimensional position
*
* "dim" [ IN ] - the dimensionality of all vectors
*
* "pos" [ IN ] - n-dimensional starting position in elements
*
* "buffer" [ OUT ] and "elem_count" [ IN ] - return buffer for read
* where "elem_count" is n-dimensional in elements
*
* "num_read" [ OUT ] - n-dimensional return parameter giving back
* the number of read elements in every dimension
*/
KFS_EXTERN rc_t CC KArrayFileRead ( const KArrayFile *self, uint8_t dim,
const uint64_t *pos, void *buffer, const uint64_t *elem_count,
uint64_t *num_read );
/* Read_v
* read one element of variable length from n-dimensional position
*
* "dim" [ IN ] - the dimensionality of all vectors
*
* "pos" [ IN ] - n-dimensional starting position in elements
*
* "buffer" [ OUT ] and "elem_count" [ IN ] - return buffer for read
* where "elem_count" is length of buffer in elements
*
* "num_read" [ OUT ] - return parameter giving back
* the number of read elements in every dimension
*/
KFS_EXTERN rc_t CC KArrayFileRead_v ( const KArrayFile *self, uint8_t dim,
const uint64_t *pos, void *buffer, const uint64_t elem_count,
uint64_t *num_read );
/* Write
* write into n-dimensional position
*
* "dim" [ IN ] - the dimensionality of all vectors
*
* "pos" [ IN ] - n-dimensional offset where to write to
* in elements
*
* "buffer" [ IN ] and "elem_count" [ IN ] - data to be written
* where "elem_count" is n-dimensional in elements
*
* "num_writ" [ OUT, NULL OKAY ] - optional return parameter
* giving number of elements actually written per dimension
*/
KFS_EXTERN rc_t CC KArrayFileWrite ( KArrayFile *self, uint8_t dim,
const uint64_t *pos, const void *buffer, const uint64_t *elem_count,
uint64_t *num_writ );
#ifdef __cplusplus
}
#endif
#endif /* _h_kfs_arrayfile_ */
|