/usr/include/shogun/lib/Array3.h is in libshogun-dev 1.1.0-4ubuntu2.
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 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 | /*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* Written (W) 1999-2009 Soeren Sonnenburg, Gunnar Raetsch
* Copyright (C) 1999-2009 Fraunhofer Institute FIRST and Max-Planck-Society
*/
#ifndef _ARRAY3_H_
#define _ARRAY3_H_
#include <shogun/lib/common.h>
#include <shogun/base/SGObject.h>
#include <shogun/lib/Array.h>
namespace shogun
{
template <class T> class CArray3;
/** @brief Template class Array3 implements a dense three dimensional array.
*
* Note that depending on compile options everything will be inlined, such that
* this is as high performance 3d-array implementation \b without error checking.
*
* */
template <class T> class CArray3: public CArray<T>
{
public:
/** default constructor */
CArray3()
: CArray<T>(1), dim1_size(1), dim2_size(1), dim3_size(1)
{
}
/** constructor
*
* @param dim1 dimension 1
* @param dim2 dimension 2
* @param dim3 dimension 3
*/
CArray3(int32_t dim1, int32_t dim2, int32_t dim3)
: CArray<T>(dim1*dim2*dim3), dim1_size(dim1), dim2_size(dim2), dim3_size(dim3)
{
}
/** constructor
*
* @param p_array another array
* @param dim1 dimension 1
* @param dim2 dimension 2
* @param dim3 dimension 3
* @param p_free_array if array must be freed
* @param p_copy_array if array must be copied
*/
CArray3(T* p_array, int32_t dim1, int32_t dim2, int32_t dim3,
bool p_free_array=true, bool p_copy_array=false)
: CArray<T>(p_array, dim1*dim2*dim3, p_free_array, p_copy_array),
dim1_size(dim1), dim2_size(dim2), dim3_size(dim3)
{
}
/** constructor
*
* @param p_array another array
* @param dim1 dimension 1
* @param dim2 dimension 2
* @param dim3 dimension 3
*/
CArray3(const T* p_array, int32_t dim1, int32_t dim2, int32_t dim3)
: CArray<T>(p_array, dim1*dim2*dim3),
dim1_size(dim1), dim2_size(dim2), dim3_size(dim3)
{
}
virtual ~CArray3() {}
/** set array's name
*
* @param p_name new name
*/
inline void set_array_name(const char * p_name)
{
CArray<T>::set_array_name(p_name);
}
/** return total array size (including granularity buffer)
*
* @param dim1 dimension 1 will be stored here
* @param dim2 dimension 2 will be stored here
* @param dim3 dimension 3 will be stored here
*/
inline void get_array_size(int32_t & dim1, int32_t & dim2, int32_t & dim3)
{
dim1=dim1_size;
dim2=dim2_size;
dim3=dim3_size;
}
/** get dimension 1
*
* @return dimension 1
*/
inline int32_t get_dim1() { return dim1_size; }
/** get dimension 2
*
* @return dimension 2
*/
inline int32_t get_dim2() { return dim2_size; }
/** get dimension 3
*
* @return dimension 3
*/
inline int32_t get_dim3() { return dim3_size ;
}
/** zero array */
inline void zero() { CArray<T>::zero(); }
/** set array with a constant */
inline void set_const(T const_elem)
{
CArray<T>::set_const(const_elem) ;
}
/** get the array
* call get_array just before messing with it DO NOT call any
* [],resize/delete functions after get_array(), the pointer may
* become invalid !
*
* @return the array
*/
inline T* get_array() { return CArray<T>::array; }
/** set the array pointer and free previously allocated memory
*
* @param p_array another array
* @param dim1 dimension 1
* @param dim2 dimensino 2
* @param dim3 dimensino 3
* @param p_free_array if array must be freed
* @param copy_array if array must be copied
*/
inline void set_array(T* p_array, int32_t dim1, int32_t dim2, int32_t dim3, bool p_free_array, bool copy_array=false)
{
dim1_size=dim1;
dim2_size=dim2;
dim3_size=dim3;
CArray<T>::set_array(p_array, dim1*dim2*dim3, p_free_array, copy_array);
}
/** resize array
*
* @param dim1 new dimension 1
* @param dim2 new dimension 2
* @param dim3 new dimension 3
* @return if resizing was successful
*/
inline bool resize_array(int32_t dim1, int32_t dim2, int32_t dim3)
{
dim1_size=dim1;
dim2_size=dim2;
dim3_size=dim3;
return CArray<T>::resize_array(dim1*dim2*dim3);
}
/** get array element at index
*
* @param idx1 index 1
* @param idx2 index 2
* @param idx3 index 3
* @return array element at index
*/
inline T get_element(int32_t idx1, int32_t idx2, int32_t idx3) const
{
ARRAY_ASSERT(idx1>=0 && idx1<dim1_size);
ARRAY_ASSERT(idx2>=0 && idx2<dim2_size);
ARRAY_ASSERT(idx3>=0 && idx3<dim3_size);
return CArray<T>::get_element(idx1+dim1_size*(idx2+dim2_size*idx3));
}
/** set array element at index 'index'
*
* @param p_element array element
* @param idx1 index 1
* @param idx2 index 2
* @param idx3 index 3
* @return if setting was successful
*/
inline bool set_element(T p_element, int32_t idx1, int32_t idx2, int32_t idx3)
{
ARRAY_ASSERT(idx1>=0 && idx1<dim1_size);
ARRAY_ASSERT(idx2>=0 && idx2<dim2_size);
ARRAY_ASSERT(idx3>=0 && idx3<dim3_size);
return CArray<T>::set_element(p_element, idx1+dim1_size*(idx2+dim2_size*idx3));
}
/** get array element at index
*
* @param idx1 index 1
* @param idx2 index 2
* @param idx3 index 3
* @return array element at index
*/
inline const T& element(int32_t idx1, int32_t idx2, int32_t idx3) const
{
ARRAY_ASSERT(idx1>=0 && idx1<dim1_size);
ARRAY_ASSERT(idx2>=0 && idx2<dim2_size);
ARRAY_ASSERT(idx3>=0 && idx3<dim3_size);
return CArray<T>::element(idx1+dim1_size*(idx2+dim2_size*idx3));
}
/** get array element at index
*
* @param idx1 index 1
* @param idx2 index 2
* @param idx3 index 3
* @return array element at index
*/
inline T& element(int32_t idx1, int32_t idx2, int32_t idx3)
{
ARRAY_ASSERT(idx1>=0 && idx1<dim1_size);
ARRAY_ASSERT(idx2>=0 && idx2<dim2_size);
ARRAY_ASSERT(idx3>=0 && idx3<dim3_size);
return CArray<T>::element(idx1+dim1_size*(idx2+dim2_size*idx3));
}
/** get element of given array at given index
*
* @param p_array another array
* @param idx1 index 1
* @param idx2 index 2
* @param idx3 index 3
* @return array element at index
*/
inline T& element(T* p_array, int32_t idx1, int32_t idx2, int32_t idx3)
{
ARRAY_ASSERT(p_array==CArray<T>::array);
ARRAY_ASSERT(idx1>=0 && idx1<dim1_size);
ARRAY_ASSERT(idx2>=0 && idx2<dim2_size);
ARRAY_ASSERT(idx3>=0 && idx3<dim3_size);
return p_array[idx1+dim1_size*(idx2+dim2_size*idx3)];
}
/** get element of given array at given index
*
* @param p_array another array
* @param idx1 index 1
* @param idx2 index 2
* @param idx3 index 3
* @param p_dim1_size size of dimension 1
* @param p_dim2_size size of dimension 2
* @return element of given array at given index
*/
inline T& element(T* p_array, int32_t idx1, int32_t idx2, int32_t idx3, int32_t p_dim1_size, int32_t p_dim2_size)
{
ARRAY_ASSERT(p_array==CArray<T>::array);
ARRAY_ASSERT(p_dim1_size==dim1_size);
ARRAY_ASSERT(p_dim2_size==dim2_size);
ARRAY_ASSERT(idx1>=0 && idx1<p_dim1_size);
ARRAY_ASSERT(idx2>=0 && idx2<p_dim2_size);
ARRAY_ASSERT(idx3>=0 && idx3<dim3_size);
return p_array[idx1+p_dim1_size*(idx2+p_dim2_size*idx3)];
}
/** operator overload for array assignment
*
* @param orig original array
* @return new array
*/
CArray3<T>& operator=(const CArray3<T>& orig)
{
CArray<T>::operator=(orig);
dim1_size=orig.dim1_size;
dim2_size=orig.dim2_size;
dim3_size=orig.dim3_size;
return *this;
}
/** display array size */
void display_size() const
{
CArray<T>::SG_PRINT( "3d-Array of size: %dx%dx%d\n",dim1_size, dim2_size, dim3_size);
}
/** display array */
void display_array() const
{
if (CArray<T>::get_name())
CArray<T>::SG_PRINT( "3d-Array '%s' of size: %dx%dx%d\n", CArray<T>::get_name(), dim1_size, dim2_size, dim3_size);
else
CArray<T>::SG_PRINT( "2d-Array of size: %dx%dx%d\n",dim1_size, dim2_size, dim3_size);
for (int32_t k=0; k<dim3_size; k++)
for (int32_t i=0; i<dim1_size; i++)
{
CArray<T>::SG_PRINT( "element(%d,:,%d) = [ ",i, k);
for (int32_t j=0; j<dim2_size; j++)
CArray<T>::SG_PRINT( "%1.1f,", (float32_t)element(i,j,k));
CArray<T>::SG_PRINT( " ]\n");
}
}
/** @return object name */
inline virtual const char* get_name() { return "Array3"; }
protected:
/** size of array's dimension 1 */
int32_t dim1_size;
/** size of array's dimension 2 */
int32_t dim2_size;
/** size of array's dimension 3 */
int32_t dim3_size;
};
}
#endif
|