page_type_interfaces.cxx

/* This file is part of the Tomographer project, which is distributed under the
 * terms of the MIT license.
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 ETH Zurich, Institute for Theoretical Physics, Philippe Faist
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */


// =============================================================================
// Type Interfaces -- Title Page
// =============================================================================

// no longer: *  - \subpage pageInterfaceRandomWalk


// =============================================================================
// MHRWStatsCollector
// =============================================================================

// =============================================================================
// Resultable
// =============================================================================

// =============================================================================
// MHWalker
// =============================================================================

// =============================================================================
// ValueCalculator Interface
// =============================================================================

// =============================================================================
// MHRandomWalkTaskCData
// =============================================================================

// =============================================================================
// Histogram
// =============================================================================

// =============================================================================
// OperatorNewProviderType
// =============================================================================

// ----need to clarify all this: TODO DOC --------
/* * \page pageInterfaceOperatorNewProviderType OperatorNewProviderType Interface
 *
 * <em>This is a &lsquo;type interface.&rsquo; See \ref pageTypeInterfaces
 * for more info on what that is.</em>
 *
 * \par operator new( ... )
 *   Define any required or desired implementations of <em>operator new</em>, as may be
 *   required for particular types (see \ref Tomographer::Tools::NeedOwnOperatorNew)
 *
 * \par typedef <own type> OperatorNewProviderType;
 *   A member type, typedef-ing the provider type itself as \a OperatorNewProviderType .
 *
 * \par template<typename T> struct OperatorNewAllocatorType { typedef .. Type; }
 *   A template struct member, capable of specifying which allocator type to use for
 *   std::vector's and other STL types of contained value \a T.
 *
 * For an example, see \ref Tomographer::Tools::EigenAlignedOperatorNewProvider.
 *
 */