pinnedvector.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_BASE_PINNEDVECTOR
#define _H_GRB_BASE_PINNEDVECTOR

#include <limits>

#include <graphblas/backends.hpp>
#include <graphblas/iomode.hpp>

#include "vector.hpp"


namespace grb {

    template< typename IOType, enum Backend implementation >
    class PinnedVector {

        private :

            static const constexpr bool
                function_was_not_implemented_in_the_selected_backend = false;


        public :

            template< typename Coord >
            PinnedVector(
                const Vector< IOType, implementation, Coord > &vector,
                const IOMode mode
            ) {
                (void) vector;
                (void) mode;
                assert( function_was_not_implemented_in_the_selected_backend );
            }

            PinnedVector() {
                assert( function_was_not_implemented_in_the_selected_backend );
            }

            ~PinnedVector() {
                assert( function_was_not_implemented_in_the_selected_backend );
            }

            inline size_t size() const noexcept {
                assert( function_was_not_implemented_in_the_selected_backend );
                return 0;
            }

            inline size_t nonzeroes() const noexcept {
                assert( function_was_not_implemented_in_the_selected_backend );
                return 0;
            }

            template< typename OutputType >
            inline OutputType getNonzeroValue(
                const size_t k, const OutputType one = OutputType()
            ) const noexcept {
                (void) k;
                assert( function_was_not_implemented_in_the_selected_backend );
                return one;
            }

            inline IOType getNonzeroValue(
                const size_t k
            ) const noexcept {
                IOType ret;
                (void) k;
                assert( function_was_not_implemented_in_the_selected_backend );
                return ret;
            }

            inline size_t getNonzeroIndex(
                const size_t k
            ) const noexcept {
                (void) k;
                assert( function_was_not_implemented_in_the_selected_backend );
                return std::numeric_limits< size_t >::max();
            }


    }; // end class grb::PinnedVector

} // end namespace ``grb''

#endif // end _H_GRB_BASE_PINNEDVECTOR