matvec.c

Go to the documentation of this file.

/*
 * Copyright (c) 2011-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.
 *
 */


#define M0_TRACE_SUBSYSTEM M0_TRACE_SUBSYS_SNS
#include "lib/trace.h"

#include "lib/errno.h"
#include "lib/memory.h"
#include "lib/misc.h"         /* memcpy */
#include "lib/assert.h"
#include "lib/types.h"
#include "sns/matvec.h"

/* ============================================================================
 GLOBAL @TODO: ALLOCATE AND FREE DATA WITH CORRESPONDING ALIGNMENT!!!
 =========================================================================== */

M0_INTERNAL int m0_matvec_init(struct m0_matvec *v, uint32_t sz)
{
        v->mv_size = sz;
        M0_ALLOC_ARR(v->mv_vector, sz);
        return v->mv_vector == NULL ? -ENOMEM : 0;
}

M0_INTERNAL void m0_matvec_fini(struct m0_matvec *v)
{
        m0_free0(&v->mv_vector);
        v->mv_size = 0;
}

M0_INTERNAL int m0_matrix_init(struct m0_matrix *m, uint32_t w, uint32_t h)
{
        uint32_t i;
        m->m_height = h;
        m->m_width = w;

        M0_ALLOC_ARR(m->m_matrix, h);
        if (m->m_matrix == NULL)
                return M0_ERR(-ENOMEM);

        for (i = 0; i < h; ++i) {
                M0_ALLOC_ARR(m->m_matrix[i], w);
                if (m->m_matrix[i] == NULL) {
                        m0_matrix_fini(m);
                        return M0_ERR(-ENOMEM);
                }
        }

        return 0;
}

M0_INTERNAL void m0_matrix_fini(struct m0_matrix *m)
{
        uint32_t i;

        for (i = 0; i < m->m_height; ++i)
                m0_free0(&m->m_matrix[i]);
        m0_free0(&m->m_matrix);
        m->m_height = m->m_width = 0;
}

m0_parity_elem_t* m0_matvec_elem_get(const struct m0_matvec *v, uint32_t x)
{
        M0_PRE(x < v->mv_size);
        return &v->mv_vector[x];
}

m0_parity_elem_t* m0_matrix_elem_get(const struct m0_matrix *m, uint32_t x, uint32_t y)
{
        M0_PRE(x < m->m_width);
        M0_PRE(y < m->m_height);
        return &m->m_matrix[y][x];
}

M0_INTERNAL void m0_matrix_print(const struct m0_matrix *mat)
{
        uint32_t x, y;
        M0_PRE(mat);

        M0_LOG(M0_DEBUG, "-----> mat %p\n", mat);

        for (y = 0; y < mat->m_height; ++y) {
                for (x = 0; x < mat->m_width; ++x)
                        M0_LOG(M0_DEBUG, "%6d ", *m0_matrix_elem_get(mat, x, y));
                M0_LOG(M0_DEBUG, "\n");
        }

        M0_LOG(M0_DEBUG, "\n");
}

M0_INTERNAL void m0_matvec_print(const struct m0_matvec *vec)
{
        uint32_t x;
        M0_PRE(vec);

        M0_LOG(M0_DEBUG, "-----> vec %p\n", vec);
        for (x = 0; x < vec->mv_size; ++x)
                M0_LOG(M0_DEBUG, "%6d\n", *m0_matvec_elem_get(vec, x));
        M0_LOG(M0_DEBUG, "\n");
}

M0_INTERNAL void m0_matrix_swap_row(struct m0_matrix *m, uint32_t r0,
                                    uint32_t r1)
{
        m0_parity_elem_t *temp;
        M0_PRE(r0 < m->m_height && r1 < m->m_height);

        temp = m->m_matrix[r0];
        m->m_matrix[r0] = m->m_matrix[r1];
        m->m_matrix[r1] = temp;
}

M0_INTERNAL void m0_matvec_swap_row(struct m0_matvec *v, uint32_t r0,
                                    uint32_t r1)
{
        m0_parity_elem_t temp;
        M0_PRE(r0 < v->mv_size && r1 < v->mv_size);

        temp = v->mv_vector[r0];
        v->mv_vector[r0] = v->mv_vector[r1];
        v->mv_vector[r1] = temp;
}

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)
{
        uint32_t x;
        M0_PRE(m);

        for (x = 0; x < m->m_width; ++x) {
                m0_parity_elem_t *e = m0_matrix_elem_get(m, x, row);
                *e = f(*e, c);
        }
}

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_parity_elem_t *e = m0_matvec_elem_get(v, row);
        M0_PRE(v);

        *e = f(*e, c);
}

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)
{
        uint32_t x;
        M0_PRE(m);

        for (x = 0; x < m->m_width; ++x) {
                m0_parity_elem_t *e0 = m0_matrix_elem_get(m, x, row0);
                m0_parity_elem_t *e1 = m0_matrix_elem_get(m, x, row1);
                *e0 = f(f0(*e0, c0), f1(*e1, c1));
        }
}

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)
{
        uint32_t x;
        M0_PRE(m);

        for (x = 0; x < m->m_width; ++x) {
                m0_parity_elem_t *e0 = m0_matrix_elem_get(m, x, row0);
                m0_parity_elem_t *e1 = m0_matrix_elem_get(m, x, row1);
                *e0 = f(f0(*e0, c0), *e1);
        }
}

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)
{
        uint32_t x;
        M0_PRE(m);

        for (x = 0; x < m->m_width; ++x) {
                m0_parity_elem_t *e0 = m0_matrix_elem_get(m, x, row0);
                m0_parity_elem_t *e1 = m0_matrix_elem_get(m, x, row1);
                *e0 = f(*e0, f1(*e1, c1));
        }
}

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)
{
        uint32_t y;

        M0_PRE(m);

        for (y = 0; y < m->m_height; ++y) {
                m0_parity_elem_t *e0 = m0_matrix_elem_get(m, col0, y);
                m0_parity_elem_t *e1 = m0_matrix_elem_get(m, col1, y);
                *e0 = f(f0(*e0, c0), f1(*e1, c1));
        }
}

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)
{
        uint32_t y;
        M0_PRE(m);

        for (y = 0; y < m->m_height; ++y) {
                m0_parity_elem_t *e = m0_matrix_elem_get(m, col, y);
                *e = f(*e, c);
        }
}

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_parity_elem_t *e0;
        m0_parity_elem_t *e1;

        M0_PRE(v);

        e0 = m0_matvec_elem_get(v, row0);
        e1 = m0_matvec_elem_get(v, row1);
        *e0 = f(f0(*e0, c0), f1(*e1, c1));
}

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_parity_elem_t *e0;
        m0_parity_elem_t *e1;

        M0_PRE(v);

        e0 = m0_matvec_elem_get(v, row0);
        e1 = m0_matvec_elem_get(v, row1);
        *e0 = f(*e0, f1(*e1, c1));
}

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_parity_elem_t *e0;
        m0_parity_elem_t *e1;

        M0_PRE(v);

        e0 = m0_matvec_elem_get(v, row0);
        e1 = m0_matvec_elem_get(v, row1);
        *e0 = f(f0(*e0, c0), *e1);
}


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)
{
        uint32_t y;
        uint32_t x;

        M0_PRE(v != NULL && m != NULL && r != NULL);
        M0_PRE(m->m_width == v->mv_size && m->m_height == r->mv_size);

        for (y = 0; y < m->m_height; ++y) {
                m0_parity_elem_t *er = m0_matvec_elem_get(r, y);
                *er = M0_PARITY_ZERO;

                for (x = 0; x < m->m_width; ++x) {
                        m0_parity_elem_t ev = *m0_matvec_elem_get(v, x);
                        m0_parity_elem_t em = *m0_matrix_elem_get(m, x, y);
                        if (ev == M0_PARITY_ZERO || em == M0_PARITY_ZERO)
                                continue;
                        *er = add(*er, mul(ev, em));
                }
        }
}

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

        M0_PRE(mat->m_width >= (submat->m_width + x_off)
               && mat->m_height >= (submat->m_height + y_off));

        for (y = 0; y < submat->m_height; ++y) {
                for (x = 0; x < submat->m_width; ++x) {
                        *m0_matrix_elem_get(submat, x, y) =
                                *m0_matrix_elem_get(mat, x + x_off, y + y_off);
                }
        }
}

M0_INTERNAL void m0_matrix_multiply(const struct m0_matrix *ma,
                                    const struct m0_matrix *mb,
                                    struct m0_matrix *mc)
{
        uint32_t         i;
        uint32_t         j;
        uint32_t         k;
        m0_parity_elem_t res;
        static m0_parity_elem_t* (*e)(const struct m0_matrix *m, uint32_t x,
                              uint32_t y) = m0_matrix_elem_get;

        M0_PRE(ma != NULL);
        M0_PRE(mb != NULL);
        M0_PRE(mc != NULL);
        M0_PRE(mc->m_height == ma->m_height);
        M0_PRE(mc->m_width == mb->m_width);
        M0_PRE(m0_matrix_is_null(mc));

        for (i = 0; i < ma->m_height; ++i) {
                for (j = 0; j < ma->m_width; ++j) {
                        for (k = 0; k < mb->m_height; ++k) {
                                res = m0_parity_mul(*e(ma, i, j), *e(mb, j, k));
                                *e(mc, i, k) = m0_parity_add(*e(mc, i, k), res);
                        }
                }

        }
}

M0_INTERNAL void m0_identity_matrix_fill(struct m0_matrix *identity_mat)
{
        uint32_t i;
        uint32_t j;
        bool     rc;

        rc = m0_matrix_is_square(identity_mat);
        M0_PRE(rc);

        for (i = 0; i < identity_mat->m_width; ++i) {
                for (j = 0; j < identity_mat->m_height; ++j) {
                        *m0_matrix_elem_get(identity_mat, i, j) = !!(i == j);
                }
        }
}

M0_INTERNAL bool m0_matrix_is_init(const struct m0_matrix *mat)
{
        return mat != NULL && mat->m_matrix != NULL && mat->m_width > 0 &&
                mat->m_height > 0;
}

M0_INTERNAL bool m0_matrix_is_null(const struct m0_matrix *mat)
{
        return m0_forall(i, mat->m_height,
                         m0_forall(j, mat->m_width,
                                   *m0_matrix_elem_get(mat, i, j) == 0));
}

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_PRE(m0_matrix_is_init(des) && m0_matrix_is_init(src));
        M0_PRE(des->m_width == src->m_width);
        M0_PRE(des_row < des->m_height && src_row < src->m_height);

        memcpy(m0_matrix_elem_get(des, 0, des_row),
                                  m0_matrix_elem_get(src, 0, src_row),
                                  src->m_width* sizeof (m0_parity_elem_t));
}

M0_INTERNAL bool m0_matrix_is_square(const struct m0_matrix *mat)
{
         return mat != NULL && mat->m_width != 0 &&
                 mat->m_width == mat->m_height;
}

#undef M0_TRACE_SUBSYSTEM

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