ROL_Stream.hpp

Go to the documentation of this file.

// @HEADER
// ************************************************************************
//
//               Rapid Optimization Library (ROL) Package
//                 Copyright (2014) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. 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.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "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 SANDIA CORPORATION OR THE
// 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.
//
// Questions? Contact lead developers:
//              Drew Kouri   (dpkouri@sandia.gov) and
//              Denis Ridzal (dridzal@sandia.gov)
//
// ************************************************************************
// @HEADER

#pragma once
#ifndef ROL_STREAM_HPP
#define ROL_STREAM_HPP

#include <ostream>
#include <string>
#include "ROL_Ptr.hpp"

namespace ROL {

namespace details {

using namespace std;

template<typename _CharT, typename _Traits>
class basic_nullstream : virtual public basic_ostream<_CharT, _Traits> {
public:
  explicit basic_nullstream() : basic_ostream<_CharT, _Traits>(NULL) {}
}; 

using nullstream = basic_nullstream<char, char_traits<char>>;

inline
Ptr<ostream> makeStreamPtr( ostream& os, bool noSuppressOutput=true ) {
  Ptr<ostream> retstream;
  if( noSuppressOutput ) retstream = makePtrFromRef<ostream>(os);
  else retstream = makePtr<nullstream>();
  return retstream; // noSuppressOutput ? makePtrFromRef( os ) : makePtr<nullstream>();
}

inline
Ptr<ostream> makeStreamPtr( Ptr<ostream> os, bool noSuppressOutput=true ) {
  Ptr<ostream> retstream;
  if( noSuppressOutput ) retstream = os;
  else retstream = makePtr<nullstream>();
  return retstream; // noSuppressOutput ? makePtrFromRef( os ) : makePtr<nullstream>();
//  return noSuppressOutput ? os : makePtr<nullstream>();
}

} // details

using details::nullstream;
using details::makeStreamPtr;

} // namespace ROL


#endif