matrix.h

Go to the documentation of this file.

/*
 * This work is licensed under a Creative Commons 
 * Attribution-Noncommercial-Share Alike 3.0 United States License.
 * 
 *    http://creativecommons.org/licenses/by-nc-sa/3.0/us/
 * 
 * You are free:
 * 
 *    to Share - to copy, distribute, display, and perform the work
 *    to Remix - to make derivative works
 * 
 * Under the following conditions:
 * 
 *    Attribution. You must attribute the work in the manner specified by the
 *    author or licensor (but not in any way that suggests that they endorse you
 *    or your use of the work).
 * 
 *    Noncommercial. You may not use this work for commercial purposes.
 * 
 *    Share Alike. If you alter, transform, or build upon this work, you may
 *    distribute the resulting work only under the same or similar license to
 *    this one.
 * 
 * For any reuse or distribution, you must make clear to others the license
 * terms of this work. The best way to do this is by including this header.
 * 
 * Any of the above conditions can be waived if you get permission from the
 * copyright holder.
 * 
 * Apart from the remix rights granted under this license, nothing in this
 * license impairs or restricts the author's moral rights.
 */


#ifndef MATRIX_H 
#define MATRIX_H 


#include <jwsc/config.h>

#include <stdlib.h>
#include <inttypes.h>

#include "jwsc/base/error.h"
#include "jwsc/math/complex.h"
#include "jwsc/vector/vector.h"


#ifdef __cplusplus
namespace jwsc {
extern "C" {
#endif


typedef struct
{
    uint32_t num_rows;

    uint32_t num_cols;

    int8_t** elts;
}
Matrix_i8;

typedef struct
{
    uint32_t num_rows;

    uint32_t num_cols;

    int16_t** elts;
}
Matrix_i16;

typedef struct
{
    uint32_t num_rows;

    uint32_t num_cols;

    int32_t** elts;
}
Matrix_i32;

typedef struct
{
    uint32_t num_rows;

    uint32_t num_cols;

    int64_t** elts;
}
Matrix_i64;


typedef struct
{
    int32_t num_rows;

    int32_t num_cols;

    uint8_t** elts;
}
Matrix_u8;

typedef struct
{
    uint32_t num_rows;

    uint32_t num_cols;

    uint16_t** elts;
}
Matrix_u16;

typedef struct
{
    uint32_t num_rows;

    uint32_t num_cols;

    uint32_t** elts;
}
Matrix_u32;

typedef struct
{
    uint32_t num_rows;

    uint32_t num_cols;

    uint64_t** elts;
}
Matrix_u64;

typedef struct
{
    uint32_t num_rows;

    uint32_t num_cols;

    float** elts;
}
Matrix_f;

typedef struct
{
    uint32_t num_rows;

    uint32_t num_cols;

    double** elts;
}
Matrix_d;

typedef struct
{
    uint32_t num_rows;

    uint32_t num_cols;

    Complex_f** elts;
}
Matrix_cf;

typedef struct
{
    uint32_t num_rows;

    uint32_t num_cols;

    Complex_d** elts;
}
Matrix_cd;


typedef enum
{
    MATRIX_ROW_VECTOR,
    MATRIX_COL_VECTOR
}
Matrix_vector;




void create_matrix_u32
(
    Matrix_u32** m_out, 
    uint32_t     num_rows, 
    uint32_t     num_cols
);

void create_matrix_i32
(
    Matrix_i32** m_out, 
    uint32_t     num_rows, 
    uint32_t     num_cols
);

void create_matrix_i64
(
    Matrix_i64** m_out, 
    uint32_t     num_rows, 
    uint32_t     num_cols
);

void create_matrix_f
(
    Matrix_f** m_out, 
    uint32_t   num_rows, 
    uint32_t   num_cols
);

void create_matrix_d
(
    Matrix_d** m_out, 
    uint32_t   num_rows, 
    uint32_t   num_cols
);

void create_matrix_cf
(
    Matrix_cf** m_out, 
    uint32_t    num_rows, 
    uint32_t    num_cols
);

void create_matrix_cd
(
    Matrix_cd** m_out, 
    uint32_t    num_rows, 
    uint32_t    num_cols
);

void create_init_matrix_u32
(
    Matrix_u32** m_out, 
    uint32_t     num_rows, 
    uint32_t     num_cols,
    uint32_t     val
);

void create_init_matrix_i32
(
    Matrix_i32** m_out, 
    uint32_t     num_rows, 
    uint32_t     num_cols,
    int32_t      val
);

void create_init_matrix_i64
(
    Matrix_i64** m_out, 
    uint32_t     num_rows, 
    uint32_t     num_cols,
    int64_t      val
);

void create_init_matrix_f
(
    Matrix_f** m_out, 
    uint32_t   num_rows, 
    uint32_t   num_cols,
    float      val
);

void create_init_matrix_d
(
    Matrix_d** m_out, 
    uint32_t   num_rows, 
    uint32_t   num_cols,
    double     val
);

void create_init_matrix_cf
(
    Matrix_cf** m_out, 
    uint32_t    num_rows, 
    uint32_t    num_cols,
    Complex_f   val
);

void create_init_matrix_cd
(
    Matrix_cd** m_out, 
    uint32_t    num_rows, 
    uint32_t    num_cols,
    Complex_d   val
);

void create_identity_matrix_u32(Matrix_u32** m_out, uint32_t size);

void create_identity_matrix_i32(Matrix_i32** m_out, uint32_t size);

void create_identity_matrix_i64(Matrix_i64** m_out, uint32_t size);

void create_identity_matrix_f(Matrix_f** m_out, uint32_t size);

void create_identity_matrix_d(Matrix_d** m_out, uint32_t size);

void create_zero_matrix_u32
(
    Matrix_u32** m_out, 
    uint32_t     num_rows, 
    uint32_t     num_cols
);

void create_zero_matrix_i32
(
    Matrix_i32** m_out, 
    uint32_t     num_rows, 
    uint32_t     num_cols
);

void create_zero_matrix_i64
(
    Matrix_i64** m_out, 
    uint32_t     num_rows, 
    uint32_t     num_cols
);

void create_zero_matrix_f
(
    Matrix_f** m_out, 
    uint32_t   num_rows, 
    uint32_t   num_cols
);

void create_zero_matrix_d
(
    Matrix_d** m_out, 
    uint32_t   num_rows, 
    uint32_t   num_cols
);

void create_zero_matrix_cf
(
    Matrix_cf** m_out, 
    uint32_t    num_rows, 
    uint32_t    num_cols
);

void create_zero_matrix_cd
(
    Matrix_cd** m_out, 
    uint32_t    num_rows, 
    uint32_t    num_cols
);

void create_diagnonal_matrix_u32
(
    Matrix_u32**      m_out, 
    const Vector_u32* v
);

void create_diagonal_matrix_i32
(
    Matrix_i32**      m_out, 
    const Vector_i32* v
);

void create_diagonal_matrix_i64
(
    Matrix_i64**      m_out, 
    const Vector_i64* v
);

void create_diagonal_matrix_f
(
    Matrix_f**      m_out, 
    const Vector_f* v
);

void create_diagonal_matrix_d
(
    Matrix_d**      m_out, 
    const Vector_d* v
);

void create_diagonal_matrix_cf
(
    Matrix_cf**      m_out, 
    const Vector_cf* v
);

void create_diagonal_matrix_cd
(
    Matrix_cd**      m_out, 
    const Vector_cd* v
);

void create_random_matrix_u32
(
    Matrix_u32** m_out, 
    uint32_t     num_rows, 
    uint32_t     num_cols,
    uint32_t     min,
    uint32_t     max
);

void create_random_matrix_i32
(
    Matrix_i32** m_out, 
    uint32_t     num_rows, 
    uint32_t     num_cols,
    int32_t      min,
    int32_t      max
);

void create_random_matrix_i64
(
    Matrix_i64** m_out, 
    uint32_t     num_rows, 
    uint32_t     num_cols,
    int64_t      min,
    int64_t      max
);

void create_random_matrix_f
(
    Matrix_f** m_out, 
    uint32_t   num_rows, 
    uint32_t   num_cols,
    float      min,
    float      max
);

void create_random_matrix_d
(
    Matrix_d** m_out, 
    uint32_t   num_rows, 
    uint32_t   num_cols,
    double     min,
    double     max
);

void create_random_matrix_cf
(
    Matrix_cf** m_out, 
    uint32_t    num_rows, 
    uint32_t    num_cols,
    Complex_f   min,
    Complex_f   max
);

void create_random_matrix_cd
(
    Matrix_cd** m_out, 
    uint32_t    num_rows, 
    uint32_t    num_cols,
    Complex_d   min,
    Complex_d   max
);

Error* copy_matrix_u32(Matrix_u32** m_out, const Matrix_u32* m_in);

Error* copy_matrix_i32(Matrix_i32** m_out, const Matrix_i32* m_in);

Error* copy_matrix_i64(Matrix_i64** m_out, const Matrix_i64* m_in);

Error* copy_matrix_f(Matrix_f** m_out, const Matrix_f* m_in);

Error* copy_matrix_d(Matrix_d** m_out, const Matrix_d* m_in);

Error* copy_matrix_cf(Matrix_cf** m_out, const Matrix_cf* m_in);

Error* copy_matrix_cd(Matrix_cd** m_out, const Matrix_cd* m_in);

Error* copy_matrix_block_u32
(
    Matrix_u32**      m_out, 
    const Matrix_u32* m_in,
    uint32_t          row_offset,
    uint32_t          col_offset,
    uint32_t          num_rows,
    uint32_t          num_cols
);

Error* copy_matrix_block_i32
(
    Matrix_i32**      m_out, 
    const Matrix_i32* m_in,
    uint32_t          row_offset,
    uint32_t          col_offset,
    uint32_t          num_rows,
    uint32_t          num_cols
);

Error* copy_matrix_block_i64
(
    Matrix_i64**      m_out, 
    const Matrix_i64* m_in,
    uint32_t          row_offset,
    uint32_t          col_offset,
    uint32_t          num_rows,
    uint32_t          num_cols
);

Error* copy_matrix_block_f
(
    Matrix_f**      m_out, 
    const Matrix_f* m_in,
    uint32_t        row_offset,
    uint32_t        col_offset,
    uint32_t        num_rows,
    uint32_t        num_cols
);

Error* copy_matrix_block_d
(
    Matrix_d**      m_out, 
    const Matrix_d* m_in,
    uint32_t        row_offset,
    uint32_t        col_offset,
    uint32_t        num_rows,
    uint32_t        num_cols
);

Error* copy_matrix_block_cf
(
    Matrix_cf**      m_out, 
    const Matrix_cf* m_in,
    uint32_t         row_offset,
    uint32_t         col_offset,
    uint32_t         num_rows,
    uint32_t         num_cols
);

Error* copy_matrix_block_cd
(
    Matrix_cd**      m_out, 
    const Matrix_cd* m_in,
    uint32_t         row_offset,
    uint32_t         col_offset,
    uint32_t         num_rows,
    uint32_t         num_cols
);

Error* copy_matrix_block_into_matrix_u32
(
    Matrix_u32*       m_1, 
    uint32_t          row_offset_1,
    uint32_t          col_offset_1,
    const Matrix_u32* m_2,
    uint32_t          row_offset_2,
    uint32_t          col_offset_2,
    uint32_t          num_rows,
    uint32_t          num_cols
);

Error* copy_matrix_block_into_matrix_i32
(
    Matrix_i32*       m_1, 
    uint32_t          row_offset_1,
    uint32_t          col_offset_1,
    const Matrix_i32* m_2,
    uint32_t          row_offset_2,
    uint32_t          col_offset_2,
    uint32_t          num_rows,
    uint32_t          num_cols
);

Error* copy_matrix_block_into_matrix_i64
(
    Matrix_i64*       m_1, 
    uint32_t          row_offset_1,
    uint32_t          col_offset_1,
    const Matrix_i64* m_2,
    uint32_t          row_offset_2,
    uint32_t          col_offset_2,
    uint32_t          num_rows,
    uint32_t          num_cols
);

Error* copy_matrix_block_into_matrix_f
(
    Matrix_f*       m_1, 
    uint32_t        row_offset_1,
    uint32_t        col_offset_1,
    const Matrix_f* m_2,
    uint32_t        row_offset_2,
    uint32_t        col_offset_2,
    uint32_t        num_rows,
    uint32_t        num_cols
);

Error* copy_matrix_block_into_matrix_d
(
    Matrix_d*       m_1, 
    uint32_t        row_offset_1,
    uint32_t        col_offset_1,
    const Matrix_d* m_2,
    uint32_t        row_offset_2,
    uint32_t        col_offset_2,
    uint32_t        num_rows,
    uint32_t        num_cols
);

Error* copy_matrix_block_into_matrix_cf
(
    Matrix_cf*       m_1, 
    uint32_t         row_offset_1,
    uint32_t         col_offset_1,
    const Matrix_cf* m_2,
    uint32_t         row_offset_2,
    uint32_t         col_offset_2,
    uint32_t         num_rows,
    uint32_t         num_cols
);

Error* copy_matrix_block_into_matrix_cd
(
    Matrix_cd*       m_1, 
    uint32_t         row_offset_1,
    uint32_t         col_offset_1,
    const Matrix_cd* m_2,
    uint32_t         row_offset_2,
    uint32_t         col_offset_2,
    uint32_t         num_rows,
    uint32_t         num_cols
);

Error* copy_vector_into_matrix_u32
(
    Matrix_u32**      m_out,
    const Matrix_u32* m_in,
    const Vector_u32* v,
    Matrix_vector     orient,
    uint32_t          index
);

Error* copy_vector_into_matrix_i32
(
    Matrix_i32**      m_out,
    const Matrix_i32* m_in,
    const Vector_i32* v,
    Matrix_vector     orient,
    uint32_t          index
);

Error* copy_vector_into_matrix_i64
(
    Matrix_i64**      m_out,
    const Matrix_i64* m_in,
    const Vector_i64* v,
    Matrix_vector     orient,
    uint32_t          index
);

Error* copy_vector_into_matrix_f
(
    Matrix_f**      m_out,
    const Matrix_f* m_in,
    const Vector_f* v,
    Matrix_vector   orient,
    uint32_t        index
);

Error* copy_vector_into_matrix_d
(
    Matrix_d**      m_out,
    const Matrix_d* m_in,
    const Vector_d* v,
    Matrix_vector   orient,
    uint32_t        index
);

Error* copy_vector_into_matrix_cf
(
    Matrix_cf**      m_out,
    const Matrix_cf* m_in,
    const Vector_cf* v,
    Matrix_vector    orient,
    uint32_t         index
);

Error* copy_vector_into_matrix_cd
(
    Matrix_cd**      m_out,
    const Matrix_cd* m_in,
    const Vector_cd* v,
    Matrix_vector    orient,
    uint32_t         index
);

Error* copy_vector_from_matrix_u32
(
    Vector_u32**      v_out,
    const Matrix_u32* m,
    Matrix_vector     orient,
    uint32_t          index
);

Error* copy_vector_from_matrix_i32
(
    Vector_i32**      v_out,
    const Matrix_i32* m,
    Matrix_vector     orient,
    uint32_t          index
);

Error* copy_vector_from_matrix_i64
(
    Vector_i64**      v_out,
    const Matrix_i64* m,
    Matrix_vector     orient,
    uint32_t          index
);

Error* copy_vector_from_matrix_f
(
    Vector_f**      v_out,
    const Matrix_f* m,
    Matrix_vector   orient,
    uint32_t        index
);

Error* copy_vector_from_matrix_d
(
    Vector_d**      v_out,
    const Matrix_d* m,
    Matrix_vector   orient,
    uint32_t        index
);

Error* copy_vector_from_matrix_cf
(
    Vector_cf**      v_out,
    const Matrix_cf* m,
    Matrix_vector    orient,
    uint32_t         index
);

Error* copy_vector_from_matrix_cd
(
    Vector_cd**      v_out,
    const Matrix_cd* m,
    Matrix_vector    orient,
    uint32_t         index
);

void free_matrix_u32(Matrix_u32* m);

void free_matrix_i32(Matrix_i32* m);

void free_matrix_i64(Matrix_i64* m);

void free_matrix_f(Matrix_f* m);

void free_matrix_d(Matrix_d* m);

void free_matrix_cf(Matrix_cf* m);

void free_matrix_cd(Matrix_cd* m);

#ifdef __cplusplus
}
}
#endif


#endif