matvec.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2013-2020 Seagate Technology LLC and/or its Affiliates
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_SNS_MAT_VEC_H__
#define __MOTR_SNS_MAT_VEC_H__

#include "lib/types.h"
#include "parity_ops.h"

struct m0_matvec {
        uint32_t          mv_size;
        m0_parity_elem_t *mv_vector;
};

M0_INTERNAL int m0_matvec_init(struct m0_matvec *v, uint32_t sz);
M0_INTERNAL void m0_matvec_fini(struct m0_matvec *v);
M0_INTERNAL void m0_matvec_print(const struct m0_matvec *vec);

m0_parity_elem_t* m0_matvec_elem_get(const struct m0_matvec *v, uint32_t x);


struct m0_matrix {
        uint32_t m_width;
        uint32_t m_height;
        m0_parity_elem_t **m_matrix;
};

M0_INTERNAL int m0_matrix_init(struct m0_matrix *m, uint32_t w, uint32_t h);
M0_INTERNAL void m0_matrix_fini(struct m0_matrix *m);
M0_INTERNAL void m0_matrix_print(const struct m0_matrix *mat);

m0_parity_elem_t* m0_matrix_elem_get(const struct m0_matrix *m, uint32_t x, uint32_t y);

typedef m0_parity_elem_t (*m0_matvec_matrix_binary_operator_t)(m0_parity_elem_t,
                                                               m0_parity_elem_t);

M0_INTERNAL void m0_matvec_row_operate(struct m0_matvec *v, uint32_t row,
                                       m0_parity_elem_t c,
                                       m0_matvec_matrix_binary_operator_t f);

M0_INTERNAL void m0_matrix_row_operate(struct m0_matrix *m, uint32_t row,
                                       m0_parity_elem_t c,
                                       m0_matvec_matrix_binary_operator_t f);

M0_INTERNAL void m0_matrix_col_operate(struct m0_matrix *m, uint32_t col,
                                       m0_parity_elem_t c,
                                       m0_matvec_matrix_binary_operator_t f);

M0_INTERNAL void m0_matrix_rows_operate(struct m0_matrix *m, uint32_t row0,
                                        uint32_t row1,
                                        m0_matvec_matrix_binary_operator_t f0,
                                        m0_parity_elem_t c0,
                                        m0_matvec_matrix_binary_operator_t f1,
                                        m0_parity_elem_t c1,
                                        m0_matvec_matrix_binary_operator_t f);

M0_INTERNAL void m0_matrix_rows_operate2(struct m0_matrix *m, uint32_t row0,
                                         uint32_t row1,
                                         m0_matvec_matrix_binary_operator_t f0,
                                         m0_parity_elem_t c0,
                                         m0_matvec_matrix_binary_operator_t f);

M0_INTERNAL void m0_matrix_rows_operate1(struct m0_matrix *m, uint32_t row0,
                                         uint32_t row1,
                                         m0_matvec_matrix_binary_operator_t f1,
                                         m0_parity_elem_t c1,
                                         m0_matvec_matrix_binary_operator_t f);

M0_INTERNAL void m0_matvec_rows_operate(struct m0_matvec *v, uint32_t row0,
                                        uint32_t row1,
                                        m0_matvec_matrix_binary_operator_t f0,
                                        m0_parity_elem_t c0,
                                        m0_matvec_matrix_binary_operator_t f1,
                                        m0_parity_elem_t c1,
                                        m0_matvec_matrix_binary_operator_t f);

M0_INTERNAL void m0_matvec_rows_operate1(struct m0_matvec *v, uint32_t row0,
                                         uint32_t row1,
                                         m0_matvec_matrix_binary_operator_t f1,
                                         m0_parity_elem_t c1,
                                         m0_matvec_matrix_binary_operator_t f);

M0_INTERNAL void m0_matvec_rows_operate2(struct m0_matvec *v, uint32_t row0,
                                         uint32_t row1,
                                         m0_matvec_matrix_binary_operator_t f0,
                                         m0_parity_elem_t c0,
                                         m0_matvec_matrix_binary_operator_t f);

M0_INTERNAL void m0_matrix_cols_operate(struct m0_matrix *m, uint32_t col0,
                                        uint32_t col1,
                                        m0_matvec_matrix_binary_operator_t f0,
                                        m0_parity_elem_t c0,
                                        m0_matvec_matrix_binary_operator_t f1,
                                        m0_parity_elem_t c1,
                                        m0_matvec_matrix_binary_operator_t f);

M0_INTERNAL void m0_matrix_swap_row(struct m0_matrix *m, uint32_t r0,
                                    uint32_t r1);

M0_INTERNAL void m0_matvec_swap_row(struct m0_matvec *v, uint32_t r0,
                                    uint32_t r1);

M0_INTERNAL void m0_matrix_vec_multiply(const struct m0_matrix *m,
                                        const struct m0_matvec *v,
                                        struct m0_matvec *r,
                                        m0_matvec_matrix_binary_operator_t mul,
                                        m0_matvec_matrix_binary_operator_t add);

M0_INTERNAL void m0_matrix_submatrix_get(const struct m0_matrix *mat,
                                         struct m0_matrix *submat,
                                         uint32_t x, uint32_t y);

M0_INTERNAL void m0_matrix_multiply(const struct m0_matrix *ma,
                                    const struct m0_matrix *mb,
                                    struct m0_matrix *mc);

M0_INTERNAL void m0_identity_matrix_fill(struct m0_matrix *identity_mat);

M0_INTERNAL bool m0_matrix_is_init(const struct m0_matrix *mat);


/* Verifies whether input matrix has all elements zero. */
M0_INTERNAL bool m0_matrix_is_null(const struct m0_matrix *mat);

M0_INTERNAL void m0_matrix_row_copy(struct m0_matrix *des,
                                    const struct m0_matrix *src,
                                    uint32_t des_row, uint32_t src_row);

M0_INTERNAL bool m0_matrix_is_square(const struct m0_matrix *mat);
/* __MOTR_SNS_MAT_VEC_H__ */
#endif

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */