mirror of
https://github.com/amd/blis.git
synced 2026-04-25 10:08:50 +00:00
f0e8634775
Details:
- Defined eqsc, eqv, and eqm operations, which set a bool depending on
whether the two scalars, two vectors, or two matrix operands are equal
(element-wise). eqsc and eqv support implicit conjugation and eqm
supports diagonal offset, diag, uplo, and trans parameters (in a
manner consistent with other level-1m operations). These operations
are currently housed under frame/util, at least for now, because they
are not computational in nature.
- Redefined bli_obj_equals() in terms of eqsc, eqv, and eqm.
- Documented eqsc, eqv, and eqm in BLISObjectAPI.md and BLISTypedAPI.md.
Also:
- Documented getsc and setsc in both docs.
- Reordered entry for setijv in BLISTypedAPI.md, and added separator
bars to both docs.
- Added missing "Observed object properties" clauses to various
levle-1v entries in BLISObjectAPI.md.
- Defined bli_apply_trans() in bli_param_macro_defs.h.
- Defined supporting _check() function, bli_l0_xxbsc_check(), in
bli_l0_check.c for eqsc.
- Programming style and whitespace updates to bli_l1m_unb_var1.c.
- Whitespace updates to bli_l0_oapi.c, bli_l1m_oapi.c
- Consolidated redundant macro redefinition for copym function pointer
type in bli_l1m_ft.h.
- Added macros to bli_oapi_ba.h, _ex.h, and bli_tapi_ba.h, _ex.h that
allow oapi and tapi source files to forego defining certain expert
functions. (Certain operations such as printv and printm do not need
to have both basic expert interfaces. This also includes eqsc, eqv,
and eqm.)
540 lines
12 KiB
C
540 lines
12 KiB
C
/*
|
|
|
|
BLIS
|
|
An object-based framework for developing high-performance BLAS-like
|
|
libraries.
|
|
|
|
Copyright (C) 2014, The University of Texas at Austin
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions are
|
|
met:
|
|
- Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
- 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.
|
|
- Neither the name(s) of the copyright holder(s) nor the names of its
|
|
contributors may be used to endorse or promote products derived
|
|
from this software without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
"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 COPYRIGHT
|
|
HOLDER OR CONTRIBUTORS 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.
|
|
|
|
*/
|
|
|
|
// Guard the function definitions so that they are only compiled when
|
|
// #included from files that define the typed API macros.
|
|
#ifdef BLIS_ENABLE_TAPI
|
|
|
|
//
|
|
// Define BLAS-like interfaces with typed operands.
|
|
//
|
|
|
|
#undef GENTFUNCR
|
|
#define GENTFUNCR( ctype, ctype_r, ch, chr, opname ) \
|
|
\
|
|
void PASTEMAC2(ch,opname,EX_SUF) \
|
|
( \
|
|
dim_t n, \
|
|
ctype* x, inc_t incx, \
|
|
ctype_r* asum \
|
|
BLIS_TAPI_EX_PARAMS \
|
|
) \
|
|
{ \
|
|
bli_init_once(); \
|
|
\
|
|
BLIS_TAPI_EX_DECLS \
|
|
\
|
|
/* If the vector length is zero, set the absolute sum return value to
|
|
zero and return early. */ \
|
|
if ( bli_zero_dim1( n ) ) \
|
|
{ \
|
|
PASTEMAC(chr,set0s)( *asum ); \
|
|
return; \
|
|
} \
|
|
\
|
|
/* Obtain a valid context from the gks if necessary. */ \
|
|
/*if ( cntx == NULL ) cntx = bli_gks_query_cntx();*/ \
|
|
\
|
|
/* Invoke the helper variant, which loops over the appropriate kernel
|
|
to implement the current operation. */ \
|
|
PASTEMAC2(ch,opname,_unb_var1) \
|
|
( \
|
|
n, \
|
|
x, incx, \
|
|
asum, \
|
|
cntx, \
|
|
rntm \
|
|
); \
|
|
}
|
|
|
|
INSERT_GENTFUNCR_BASIC0( asumv )
|
|
|
|
|
|
#undef GENTFUNC
|
|
#define GENTFUNC( ctype, ch, opname ) \
|
|
\
|
|
void PASTEMAC2(ch,opname,EX_SUF) \
|
|
( \
|
|
uplo_t uploa, \
|
|
dim_t m, \
|
|
ctype* a, inc_t rs_a, inc_t cs_a \
|
|
BLIS_TAPI_EX_PARAMS \
|
|
) \
|
|
{ \
|
|
bli_init_once(); \
|
|
\
|
|
BLIS_TAPI_EX_DECLS \
|
|
\
|
|
/* If either dimension is zero, return early. */ \
|
|
if ( bli_zero_dim2( m, m ) ) return; \
|
|
\
|
|
/* Obtain a valid context from the gks if necessary. */ \
|
|
if ( cntx == NULL ) cntx = bli_gks_query_cntx(); \
|
|
\
|
|
/* Invoke the helper variant, which loops over the appropriate kernel
|
|
to implement the current operation. */ \
|
|
PASTEMAC2(ch,opname,_unb_var1) \
|
|
( \
|
|
uploa, \
|
|
m, \
|
|
a, rs_a, cs_a, \
|
|
cntx, \
|
|
rntm \
|
|
); \
|
|
}
|
|
|
|
INSERT_GENTFUNC_BASIC0( mkherm )
|
|
INSERT_GENTFUNC_BASIC0( mksymm )
|
|
INSERT_GENTFUNC_BASIC0( mktrim )
|
|
|
|
|
|
#undef GENTFUNCR
|
|
#define GENTFUNCR( ctype, ctype_r, ch, chr, opname ) \
|
|
\
|
|
void PASTEMAC2(ch,opname,EX_SUF) \
|
|
( \
|
|
dim_t n, \
|
|
ctype* x, inc_t incx, \
|
|
ctype_r* norm \
|
|
BLIS_TAPI_EX_PARAMS \
|
|
) \
|
|
{ \
|
|
bli_init_once(); \
|
|
\
|
|
BLIS_TAPI_EX_DECLS \
|
|
\
|
|
/* If the vector length is zero, set the norm to zero and return
|
|
early. */ \
|
|
if ( bli_zero_dim1( n ) ) \
|
|
{ \
|
|
PASTEMAC(chr,set0s)( *norm ); \
|
|
return; \
|
|
} \
|
|
\
|
|
/* Obtain a valid context from the gks if necessary. */ \
|
|
if ( cntx == NULL ) cntx = bli_gks_query_cntx(); \
|
|
\
|
|
/* Invoke the helper variant, which loops over the appropriate kernel
|
|
to implement the current operation. */ \
|
|
PASTEMAC2(ch,opname,_unb_var1) \
|
|
( \
|
|
n, \
|
|
x, incx, \
|
|
norm, \
|
|
cntx, \
|
|
rntm \
|
|
); \
|
|
}
|
|
|
|
INSERT_GENTFUNCR_BASIC0( norm1v )
|
|
INSERT_GENTFUNCR_BASIC0( normfv )
|
|
INSERT_GENTFUNCR_BASIC0( normiv )
|
|
|
|
|
|
#undef GENTFUNCR
|
|
#define GENTFUNCR( ctype, ctype_r, ch, chr, opname ) \
|
|
\
|
|
void PASTEMAC2(ch,opname,EX_SUF) \
|
|
( \
|
|
doff_t diagoffx, \
|
|
diag_t diagx, \
|
|
uplo_t uplox, \
|
|
dim_t m, \
|
|
dim_t n, \
|
|
ctype* x, inc_t rs_x, inc_t cs_x, \
|
|
ctype_r* norm \
|
|
BLIS_TAPI_EX_PARAMS \
|
|
) \
|
|
{ \
|
|
bli_init_once(); \
|
|
\
|
|
BLIS_TAPI_EX_DECLS \
|
|
\
|
|
/* If either dimension is zero, set the norm to zero and return
|
|
early. */ \
|
|
if ( bli_zero_dim2( m, n ) ) \
|
|
{ \
|
|
PASTEMAC(chr,set0s)( *norm ); \
|
|
return; \
|
|
} \
|
|
\
|
|
/* Obtain a valid context from the gks if necessary. */ \
|
|
if ( cntx == NULL ) cntx = bli_gks_query_cntx(); \
|
|
\
|
|
/* Invoke the helper variant, which loops over the appropriate kernel
|
|
to implement the current operation. */ \
|
|
PASTEMAC2(ch,opname,_unb_var1) \
|
|
( \
|
|
diagoffx, \
|
|
diagx, \
|
|
uplox, \
|
|
m, \
|
|
n, \
|
|
x, rs_x, cs_x, \
|
|
norm, \
|
|
cntx, \
|
|
rntm \
|
|
); \
|
|
}
|
|
|
|
INSERT_GENTFUNCR_BASIC0( norm1m )
|
|
INSERT_GENTFUNCR_BASIC0( normfm )
|
|
INSERT_GENTFUNCR_BASIC0( normim )
|
|
|
|
|
|
#undef GENTFUNCR
|
|
#define GENTFUNCR( ctype, ctype_r, ch, chr, opname ) \
|
|
\
|
|
void PASTEMAC2(ch,opname,EX_SUF) \
|
|
( \
|
|
dim_t n, \
|
|
ctype* x, inc_t incx \
|
|
BLIS_TAPI_EX_PARAMS \
|
|
) \
|
|
{ \
|
|
bli_init_once(); \
|
|
\
|
|
BLIS_TAPI_EX_DECLS \
|
|
\
|
|
/* If the vector length is zero, return early. */ \
|
|
if ( bli_zero_dim1( n ) ) return; \
|
|
\
|
|
/* Obtain a valid context from the gks if necessary. */ \
|
|
/*if ( cntx == NULL ) cntx = bli_gks_query_cntx();*/ \
|
|
\
|
|
ctype_r norm; \
|
|
\
|
|
/* Set the norm to zero. */ \
|
|
PASTEMAC(chr,set0s)( norm ); \
|
|
\
|
|
/* Iterate at least once, but continue iterating until the norm is not zero. */ \
|
|
while ( PASTEMAC(chr,eq0)( norm ) ) \
|
|
{ \
|
|
/* Invoke the helper variant, which loops over the appropriate kernel
|
|
to implement the current operation. */ \
|
|
PASTEMAC2(ch,opname,_unb_var1) \
|
|
( \
|
|
n, \
|
|
x, incx, \
|
|
cntx, \
|
|
rntm \
|
|
); \
|
|
\
|
|
/* Check the 1-norm of the randomzied vector. In the unlikely event that
|
|
the 1-norm is zero, it means that *all* elements are zero, in which
|
|
case we want to re-randomize until the 1-norm is not zero. */ \
|
|
PASTEMAC2(ch,norm1v,BLIS_TAPI_EX_SUF) \
|
|
( \
|
|
n, \
|
|
x, incx, \
|
|
&norm, \
|
|
cntx, \
|
|
rntm \
|
|
); \
|
|
} \
|
|
}
|
|
|
|
INSERT_GENTFUNCR_BASIC0( randv )
|
|
INSERT_GENTFUNCR_BASIC0( randnv )
|
|
|
|
|
|
#undef GENTFUNCR
|
|
#define GENTFUNCR( ctype, ctype_r, ch, chr, opname ) \
|
|
\
|
|
void PASTEMAC2(ch,opname,EX_SUF) \
|
|
( \
|
|
doff_t diagoffx, \
|
|
uplo_t uplox, \
|
|
dim_t m, \
|
|
dim_t n, \
|
|
ctype* x, inc_t rs_x, inc_t cs_x \
|
|
BLIS_TAPI_EX_PARAMS \
|
|
) \
|
|
{ \
|
|
bli_init_once(); \
|
|
\
|
|
BLIS_TAPI_EX_DECLS \
|
|
\
|
|
/* If either dimension is zero, return early. */ \
|
|
if ( bli_zero_dim2( m, n ) ) return; \
|
|
\
|
|
/* Obtain a valid context from the gks if necessary. */ \
|
|
/*if ( cntx == NULL ) cntx = bli_gks_query_cntx();*/ \
|
|
\
|
|
ctype_r norm; \
|
|
\
|
|
/* Set the norm to zero. */ \
|
|
PASTEMAC(chr,set0s)( norm ); \
|
|
\
|
|
/* Iterate at least once, but continue iterating until the norm is not zero. */ \
|
|
while ( PASTEMAC(chr,eq0)( norm ) ) \
|
|
{ \
|
|
/* Invoke the helper variant, which loops over the appropriate kernel
|
|
to implement the current operation. */ \
|
|
PASTEMAC2(ch,opname,_unb_var1) \
|
|
( \
|
|
diagoffx, \
|
|
uplox, \
|
|
m, \
|
|
n, \
|
|
x, rs_x, cs_x, \
|
|
cntx, \
|
|
rntm \
|
|
); \
|
|
\
|
|
/* Check the 1-norm of the randomzied matrix. In the unlikely event that
|
|
the 1-norm is zero, it means that *all* elements are zero, in which
|
|
case we want to re-randomize until the 1-norm is not zero. */ \
|
|
PASTEMAC2(ch,norm1m,BLIS_TAPI_EX_SUF) \
|
|
( \
|
|
diagoffx, \
|
|
BLIS_NONUNIT_DIAG, \
|
|
uplox, \
|
|
m, \
|
|
n, \
|
|
x, rs_x, cs_x, \
|
|
&norm, \
|
|
cntx, \
|
|
rntm \
|
|
); \
|
|
} \
|
|
}
|
|
|
|
INSERT_GENTFUNCR_BASIC0( randm )
|
|
INSERT_GENTFUNCR_BASIC0( randnm )
|
|
|
|
|
|
#undef GENTFUNCR
|
|
#define GENTFUNCR( ctype, ctype_r, ch, chr, opname ) \
|
|
\
|
|
void PASTEMAC2(ch,opname,EX_SUF) \
|
|
( \
|
|
dim_t n, \
|
|
ctype* x, inc_t incx, \
|
|
ctype_r* scale, \
|
|
ctype_r* sumsq \
|
|
BLIS_TAPI_EX_PARAMS \
|
|
) \
|
|
{ \
|
|
bli_init_once(); \
|
|
\
|
|
BLIS_TAPI_EX_DECLS \
|
|
\
|
|
/* If x is zero length, return with scale and sumsq unchanged. */ \
|
|
if ( bli_zero_dim1( n ) ) return; \
|
|
\
|
|
/* Obtain a valid context from the gks if necessary. */ \
|
|
/*if ( cntx == NULL ) cntx = bli_gks_query_cntx();*/ \
|
|
\
|
|
/* Invoke the helper variant, which loops over the appropriate kernel
|
|
to implement the current operation. */ \
|
|
PASTEMAC2(ch,opname,_unb_var1) \
|
|
( \
|
|
n, \
|
|
x, incx, \
|
|
scale, \
|
|
sumsq, \
|
|
cntx, \
|
|
rntm \
|
|
); \
|
|
}
|
|
|
|
INSERT_GENTFUNCR_BASIC0( sumsqv )
|
|
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// Operations with only basic interfaces.
|
|
|
|
#ifdef BLIS_TAPI_BASIC
|
|
|
|
#undef GENTFUNC
|
|
#define GENTFUNC( ctype, ch, opname ) \
|
|
\
|
|
void PASTEMAC(ch,opname) \
|
|
( \
|
|
conj_t conjchi, \
|
|
ctype* chi, \
|
|
ctype* psi, \
|
|
bool* is_eq \
|
|
) \
|
|
{ \
|
|
bli_init_once(); \
|
|
\
|
|
ctype chi_conj; \
|
|
\
|
|
PASTEMAC(ch,copycjs)( conjchi, *chi, chi_conj ); \
|
|
\
|
|
*is_eq = PASTEMAC(ch,eq)( chi_conj, *psi ); \
|
|
}
|
|
|
|
INSERT_GENTFUNC_BASIC0( eqsc )
|
|
|
|
|
|
#undef GENTFUNC
|
|
#define GENTFUNC( ctype, ch, opname ) \
|
|
\
|
|
void PASTEMAC(ch,opname) \
|
|
( \
|
|
conj_t conjx, \
|
|
dim_t n, \
|
|
ctype* x, inc_t incx, \
|
|
ctype* y, inc_t incy, \
|
|
bool* is_eq \
|
|
) \
|
|
{ \
|
|
bli_init_once(); \
|
|
\
|
|
/* If x is zero length, return with a result of TRUE. */ \
|
|
if ( bli_zero_dim1( n ) ) { *is_eq = TRUE; return; } \
|
|
\
|
|
/* Obtain a valid context from the gks if necessary. */ \
|
|
/*if ( cntx == NULL ) cntx = bli_gks_query_cntx();*/ \
|
|
\
|
|
*is_eq = PASTEMAC2(ch,opname,_unb_var1) \
|
|
( \
|
|
conjx, \
|
|
n, \
|
|
x, incx, \
|
|
y, incy \
|
|
); \
|
|
}
|
|
|
|
INSERT_GENTFUNC_BASIC0( eqv )
|
|
|
|
|
|
#undef GENTFUNC
|
|
#define GENTFUNC( ctype, ch, opname ) \
|
|
\
|
|
void PASTEMAC(ch,opname) \
|
|
( \
|
|
doff_t diagoffx, \
|
|
diag_t diagx, \
|
|
uplo_t uplox, \
|
|
trans_t transx, \
|
|
dim_t m, \
|
|
dim_t n, \
|
|
ctype* x, inc_t rs_x, inc_t cs_x, \
|
|
ctype* y, inc_t rs_y, inc_t cs_y, \
|
|
bool* is_eq \
|
|
) \
|
|
{ \
|
|
bli_init_once(); \
|
|
\
|
|
/* If x has a zero dimension, return with a result of TRUE. See the
|
|
_unb_var() variant for why we return TRUE in this scenario. */ \
|
|
if ( bli_zero_dim2( m, n ) ) { *is_eq = TRUE; return; } \
|
|
\
|
|
/* Obtain a valid context from the gks if necessary. */ \
|
|
/*if ( cntx == NULL ) cntx = bli_gks_query_cntx();*/ \
|
|
\
|
|
/* Invoke the helper variant. */ \
|
|
*is_eq = PASTEMAC2(ch,opname,_unb_var1) \
|
|
( \
|
|
diagoffx, \
|
|
diagx, \
|
|
uplox, \
|
|
transx, \
|
|
m, \
|
|
n, \
|
|
x, rs_x, cs_x, \
|
|
y, rs_y, cs_y \
|
|
); \
|
|
}
|
|
|
|
INSERT_GENTFUNC_BASIC0( eqm )
|
|
|
|
|
|
#undef GENTFUNC
|
|
#define GENTFUNC( ctype, ch, opname, varname ) \
|
|
\
|
|
void PASTEMAC(ch,opname) \
|
|
( \
|
|
char* s1, \
|
|
dim_t n, \
|
|
void* x, inc_t incx, \
|
|
char* format, \
|
|
char* s2 \
|
|
) \
|
|
{ \
|
|
bli_init_once(); \
|
|
\
|
|
PASTEMAC(ch,varname) \
|
|
( \
|
|
stdout, \
|
|
s1, \
|
|
n, \
|
|
x, incx, \
|
|
format, \
|
|
s2 \
|
|
); \
|
|
}
|
|
|
|
INSERT_GENTFUNC_BASIC_I( printv, fprintv )
|
|
|
|
|
|
#undef GENTFUNC
|
|
#define GENTFUNC( ctype, ch, opname, varname ) \
|
|
\
|
|
void PASTEMAC(ch,opname) \
|
|
( \
|
|
char* s1, \
|
|
dim_t m, \
|
|
dim_t n, \
|
|
void* x, inc_t rs_x, inc_t cs_x, \
|
|
char* format, \
|
|
char* s2 \
|
|
) \
|
|
{ \
|
|
bli_init_once(); \
|
|
\
|
|
PASTEMAC(ch,varname) \
|
|
( \
|
|
stdout, \
|
|
s1, \
|
|
m, \
|
|
n, \
|
|
x, rs_x, cs_x, \
|
|
format, \
|
|
s2 \
|
|
); \
|
|
}
|
|
|
|
INSERT_GENTFUNC_BASIC_I( printm, fprintm )
|
|
|
|
#endif // #ifdef BLIS_TAPI_BASIC
|
|
|
|
|
|
#endif
|
|
|