ndarray.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (C) 2019 by Soulaymen Chouri                                   *
 *                                                                          *
 * This file is part of TensorBolt.                                         *
 *                                                                          *
 * What follows is the Modified BSD License.                                *
 *     See also http://www.opensource.org/licenses/BSD-3-Clause             *
 * Copyright (c) 2019, Soulaymen Chouri. All rights reserved.               *
 * Redistribution and use in source and binary forms, with or without       *
 * modification, are permitted provided that the following conditions       *
 * are met:                                                                 *
 *                                                                          *
 *      1. Redistributions of source code must retain the above copyright   *
 *         notice, this list of conditions and the following disclaimer.    *
 *                                                                          *
 *      2. 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.                                           *
 *                                                                          *
 *      3. Neither the name of the author nor the names of other            *
 *         contributors may be used to endorse or promote products derived  *
 *         from this software without specific prior written permission.    *
 *                                                                          *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS "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 AUTHORS 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 _TB_NDARRAY_H_
#define _TB_NDARRAY_H_

#include <stdint.h>
#include <stdarg.h>

#ifndef __FUNCTION_NAME__
#ifdef WIN32   //WINDOWS
#define __FUNCTION_NAME__   __FUNCTION__
#else          //*NIX
#define __FUNCTION_NAME__   __func__
#endif
#endif

#define TB_ASSERT_LOG

#if defined(TB_ASSERT_STANDARD)
#define ASSERT(c ,msg, ...) assert(c)
#elif defined (TB_ASSERT_LOG)
#define ASSERT(c, msg, ...) nda_assert(c, #c, __FUNCTION_NAME__ , msg, ##__VA_ARGS__)
#elif defined (TB_ASSERT_NONE)
#define ASSERT(c, msg, ...)
#else
#error Please define an assertion policy.
#endif


/*
 * change this to double if you need
 */
#define TB_FLOAT 0
#define TB_DOUBLE 1

#define TB_TYPE TB_FLOAT

#if TB_TYPE == TB_FLOAT
typedef float tb_float;
#else
typedef double tb_float;
#endif

struct NDShape;

struct NDShapeStack;

void nda_ShapeStackInit(struct NDShapeStack* stack, struct NDShape* shape);

uint8_t nda_ShapeStackCanPop(struct NDShapeStack* stack);

uint64_t nda_ShapeStackPop(struct NDShapeStack* stack);

typedef enum NDArrayLocation {
    NDA_LOC_HOST_MEM=0,   
    NDA_LOC_DEVICE_MEM=0, 
}NDArrayLocation;

struct NDArray;

struct NDShape* nda_newShape(uint64_t rank, ...);

struct NDShape* nda_newShapeFromArray(uint64_t rank, uint64_t* dims);

struct NDShape* nda_newShapeFromArrayCopy(uint64_t rank, uint64_t* dims);

void nda_debugShape(struct NDShape* shape);

struct NDShape* nda_copyShape(struct NDShape* shape);

uint8_t nda_shapeCanBroadCast(struct NDShape* shape1, struct NDShape* shape2);

char* nda_shapeToString(struct NDShape* shape);

void nda_debugValue(struct NDArray* tensor);

uint64_t nda_getTotalSize(struct NDShape* shape);

struct NDArray* nda_alloc(struct NDShape* shape);

struct NDArray* nda_randomNormal(struct NDShape* shape, float mu, float sig);

struct NDArray* nda_linspace(tb_float a, tb_float b, uint64_t n);

struct NDArray* nda_ones(struct NDShape* shape);

struct NDArray* nda_fill(struct NDShape* shape, tb_float value);

struct NDArray* nda_copy(struct NDArray* x);

void nda_reshape(struct NDArray* x, struct NDShape* shape);

void nda_free(struct NDArray* array);

tb_float nda_get(struct NDArray* array, uint64_t* index);


struct NDArray* nda_slice(struct NDArray* array, uint64_t* index);


tb_float nda_vget(struct NDArray* array, uint64_t* index, struct NDShape* vshape);

tb_float nda_get1D(struct NDArray* array, uint64_t index);

tb_float nda_vget1D(struct NDArray* array, uint64_t index);


#endif