Skip to content

521 clean up utility functions for printing alp containers #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
4 commits merged into from
Sep 8, 2022
Merged

521 clean up utility functions for printing alp containers #68

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
19fa72b
Add functionalities to check whether a given coordinate falls inside …
Sep 8, 2022
488dc13
Add utility functions for printing ALP containers
Sep 8, 2022
1526d9e
Use new print functions in unit tests
Sep 8, 2022
827f7da
Fix capitalization of a typename
Sep 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 59 additions & 0 deletions include/alp/structures.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,65 @@ namespace alp {
typedef OpenInterval type;
};

/**
* Checks if a given diagonal belongs to the given interval.
*/
template< typename Interval >
bool is_within_interval( const std::ptrdiff_t diag_offset ) {
return ( ( diag_offset >= Interval::left ) && ( diag_offset < Interval::right ) );
}

namespace internal {

/**
* Checks if a pair of coordinates (i, j) belong to non-zero structure
* of the band defined by the band_index and the union of bands.
* \note Does not check for matrix dimensions.
*/

/** Specialization for out-of-bounds band index */
template<
size_t band_index, typename Bands,
std::enable_if_t<
band_index >= std::tuple_size< Bands >::value
> * = nullptr
>
bool is_non_zero( const size_t i, const size_t j ) {
(void)i;
(void)j;
return false;
}

/** Specialization for within-the-bounds band index */
template<
size_t band_index, typename Bands,
std::enable_if_t<
band_index < std::tuple_size< Bands >::value
> * = nullptr
>
bool is_non_zero( const size_t i, const size_t j ) {

using band_interval = typename std::tuple_element< band_index, Bands >::type;

if( is_within_interval< band_interval >( static_cast< std::ptrdiff_t >( j ) - static_cast< std::ptrdiff_t >( i ) ) ) {
return true;
} else {
return is_non_zero< band_index + 1, Bands >( i, j );
}
}

} // namespace internal

/**
* Checks if a pair of coordinates (i, j) belong to non-zero structure
* of the band defined by the band_index and the union of bands.
* \note Does not check for matrix dimensions.
*/
template< typename Structure >
bool is_non_zero( const size_t i, const size_t j ) {
return internal::is_non_zero< 0, typename Structure::band_intervals >( i, j );
}

namespace internal {
/**
* @internal Compile-time check if a tuple of intervals is sorted and non-overlapping.
Expand Down
41 changes: 2 additions & 39 deletions tests/unit/alp_views.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,45 +18,8 @@
#include <utility>
#include <iostream>

#include "alp.hpp"

template< typename MatrixType >
void print_matrix( std::string name, const MatrixType &A ) {

if( ! alp::internal::getInitialized( A ) ) {
std::cout << "Matrix " << name << " uninitialized.\n";
return;
}

std::cout << "Matrix " << name << " of size " << alp::dims( A ).first << " x " << alp::dims( A ).second << " contains the following elements:\n";

for( size_t row = 0; row < alp::nrows( A ); ++row ) {
std::cout << "[\t";
for( size_t col = 0; col < alp::ncols( A ); ++col ) {
auto pos = alp::internal::getStorageIndex( A, row, col );
// std::cout << "(" << pos << "): ";
std::cout << alp::internal::access( A, pos ) << "\t";
}
std::cout << "]\n";
}
}

template< typename VectorType >
void print_vector( std::string name, const VectorType &v ) {

if( ! alp::internal::getInitialized( v ) ) {
std::cout << "Vector " << name << " uninitialized.\n";
return;
}

std::cout << "Vector " << name << " of size " << alp::getLength( v ) << " contains the following elements:\n";

std::cout << "[\t";
for( size_t i = 0; i < alp::getLength( v ); ++i ) {
std::cout << v[ i ] << "\t";
}
std::cout << "]\n";
}
#include <alp.hpp>
#include "../utils/print_alp_containers.hpp"

template< typename T >
void init_matrix( std::vector< T > &A, const size_t rows, const size_t cols ) {
Expand Down
17 changes: 0 additions & 17 deletions tests/unit/dense_dot_norm2.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,23 +31,6 @@ const T1 testval1 = 1.5;
const T1 testval2 = -1;
const T1 testval3 = 2.;

template< typename VectorType >
void print_vector( std::string name, const VectorType &v ) {

if( ! alp::internal::getInitialized( v ) ) {
std::cout << "Vector " << name << " uninitialized.\n";
return;
}

std::cout << "Vector " << name << " of size " << alp::getLength( v ) << " contains the following elements:\n";

std::cout << "[\t";
for( size_t i = 0; i < alp::getLength( v ); ++i ) {
std::cout << v[ i ] << "\t";
}
std::cout << "]\n";
}

void alp_program( const size_t &n, alp::RC &rc ) {

{
Expand Down
17 changes: 0 additions & 17 deletions tests/unit/dense_fold.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,23 +28,6 @@ const T1 testval1 = 1.5;
const T1 testval2 = -1;
const T1 testval3 = 2.;

template< typename VectorType >
void print_vector( std::string name, const VectorType &v ) {

if( ! alp::internal::getInitialized( v ) ) {
std::cout << "Vector " << name << " uninitialized.\n";
return;
}

std::cout << "Vector " << name << " of size " << alp::getLength( v ) << " contains the following elements:\n";

std::cout << "[\t";
for( size_t i = 0; i < alp::getLength( v ); ++i ) {
std::cout << v[ i ] << "\t";
}
std::cout << "]\n";
}

void alp_program( const size_t &n, alp::RC &rc ) {

// test 1 foldl( vector, scalar, mul_op)
Expand Down
16 changes: 0 additions & 16 deletions tests/unit/dense_matrix_eWiseApply.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,6 @@

using namespace alp;

template< typename Structure >
void print_matrix( const alp::Matrix< double, Structure > & A) {
(void)A;
// if( ! alp::internal::getInitialized< double >( A ) ) {
// std::cout << "Matrix is uninitialized, nothing to print.\n";
// return;
// }
// const double * Araw = alp::getRaw( internal::getContainer( A ) );
// for( size_t row = 0; row < alp::nrows( A ); ++row ) {
// for( size_t col = 0; col < alp::ncols( A ); ++col ) {
// std::cout << Araw[row * alp::ncols( A ) + col] << " ";
// }
// std::cout << "\n";
// }
}

void alp_program( const size_t & n, alp::RC & rc ) {
alp::Semiring< alp::operators::add< double >, alp::operators::mul< double >, alp::identities::zero, alp::identities::one > ring;

Expand Down
21 changes: 1 addition & 20 deletions tests/unit/dense_mxm.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,10 @@
#include <vector>

#include <alp.hpp>
#include "../utils/print_alp_containers.hpp"

using namespace alp;

template< typename T, typename Structure >
void print_matrix( std::string name, const alp::Matrix< T, Structure > & A) {

if( ! alp::internal::getInitialized( A ) ) {
std::cout << "Matrix " << name << " uninitialized.\n";
return;
}

std::cout << name << ":" << std::endl;
for( size_t row = 0; row < alp::nrows( A ); ++row ) {
std::cout << "[\t";
for( size_t col = 0; col < alp::ncols( A ); ++col ) {
auto pos = internal::getStorageIndex( A, row, col );
// std::cout << "(" << pos << "): ";
std::cout << internal::access(A, pos ) << "\t";
}
std::cout << "]" << std::endl;
}
}

template< typename T >
void print_stdvec_as_matrix( std::string name, const std::vector< T > & vA, const size_t m, const size_t n, const size_t lda ) {

Expand Down
21 changes: 1 addition & 20 deletions tests/unit/dense_outer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,7 @@
#include <iostream>

#include "alp.hpp"

template< typename MatrixType >
void print_matrix( std::string name, const MatrixType &A) {

if( ! alp::internal::getInitialized( A ) ) {
std::cout << "Matrix " << name << " uninitialized.\n";
return;
}

std::cout << name << ":" << std::endl;
for( size_t row = 0; row < alp::nrows( A ); ++row ) {
std::cout << "[\t";
for( size_t col = 0; col < alp::ncols( A ); ++col ) {
auto pos = alp::internal::getStorageIndex( A, row, col );
// std::cout << "(" << pos << "): ";
std::cout << alp::internal::access( A, pos ) << "\t";
}
std::cout << "]" << std::endl;
}
}
#include "../utils/print_alp_containers.hpp"

template< typename T >
void print_stdvec_as_matrix( std::string name, const std::vector< T > &vA, const size_t m, const size_t n, const size_t lda ) {
Expand Down
76 changes: 76 additions & 0 deletions tests/utils/print_alp_containers.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@

/*
* Copyright 2021 Huawei Technologies Co., Ltd.
*
* 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.
*/

#ifndef _H_TEST_UTILS_PRINT_ALP_CONTAINERS
#define _H_TEST_UTILS_PRINT_ALP_CONTAINERS

#include <iomanip>

#include <alp.hpp>

template<
typename MatrixType,
std::enable_if_t< alp::is_matrix< MatrixType >::value > * = nullptr
>
void print_matrix( std::string name, const MatrixType &A ) {

if( ! alp::internal::getInitialized( A ) ) {
std::cout << "Matrix " << name << " uninitialized. Nothing to print.\n";
return;
}

constexpr bool is_sym { alp::structures::is_a< typename alp::inspect_structure< MatrixType >::type, alp::structures::Symmetric >::value };
// Temporary until adding multiple symmetry directions
constexpr bool sym_up { is_sym };

std::cout << name << ":" << std::endl;
for( size_t row = 0; row < alp::nrows( A ); ++row ) {
std::cout << "|";
for( size_t col = 0; col < alp::ncols( A ); ++col ) {
if( alp::is_non_zero< typename alp::inspect_structure< MatrixType >::type >( row, col ) ) {
const auto k = ( !is_sym || ( is_sym && ( sym_up == ( row > col ) ) ) ) ?
alp::internal::getStorageIndex( A, row, col ) :
alp::internal::getStorageIndex( A, col, row );
std::cout << std::setprecision( 3 ) << "\t" << alp::internal::access( A, k );
} else {
std::cout << std::setprecision( 0 ) << "\t" << 0;
}
}
std::cout << "\t" << "|" << "\n";
}
}

template<
typename VectorType,
std::enable_if_t< alp::is_vector< VectorType >::value > * = nullptr
>
void print_vector( std::string name, const VectorType &v ) {

if( ! alp::internal::getInitialized( v ) ) {
std::cout << "Vector " << name << " uninitialized. Nothing to print.\n";
return;
}

std::cout << name << ":" << std::endl;
std::cout << "[";
for( size_t i = 0; i < alp::nrows( v ); ++i ) {
std::cout << std::setprecision( 3 ) << "\t" << v[ i ];
}
std::cout << "\t" << "]" << "\n";
}

#endif // _H_TEST_UTILS_PRINT_ALP_CONTAINERS