collectives.hpp

Go to the documentation of this file.

/*
 *   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_GRB_COLL_BASE
#define _H_GRB_COLL_BASE

#include <graphblas/backends.hpp>
#include <graphblas/descriptors.hpp>
#include <graphblas/rc.hpp>


namespace grb {

    template< enum Backend implementation >
    class collectives {

        private:

            collectives() {}


        public:

            template<
                Descriptor descr = descriptors::no_operation,
                typename Operator,
                typename IOType
            >
            static RC allreduce( IOType &inout, const Operator op = Operator() ) {
                (void) inout;
                (void)op;
                return PANIC;
            }

            template<
                Descriptor descr = descriptors::no_operation,
                typename Operator,
                typename IOType
            >
            static RC reduce(
                IOType &inout,
                const size_t root = 0,
                const Operator op = Operator()
            ) {
                (void) inout;
                (void) op;
                (void) root;
                return PANIC;
            }

            template< typename IOType >
            static RC broadcast( IOType &inout, const size_t root = 0 ) {
                (void) inout;
                (void) root;
                return PANIC;
            }

            template< Descriptor descr = descriptors::no_operation, typename IOType >
            static RC broadcast(
                IOType * inout,
                const size_t size,
                const size_t root = 0
            ) {
                (void) inout;
                (void) size;
                (void) root;
                return PANIC;
            }

    }; // end class ``collectives''

} // end namespace grb

#endif // end _H_GRB_COLL_BASE