Ignore:
Timestamp:
Sep 22, 2006, 12:07:54 PM (15 years ago)
Author:
Peter
Message:

fixes #145 cleaning up interface of DataLook2D. Those function were introduced only to avoid dynamic_casts in SubsetGenerator? and in the end dynamic_cast was necessary anyway, so these functions are just contaminating the interface.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/c++_tools/classifier/MatrixLookup.h

    r648 r656  
    6969    /// Constructor creating a lookup into a sub-matrix of @a matrix.
    7070    ///
    71     /// If @a row_vectors is true the new MatrixLookup will be consist
     71    /// If @a row_vectors is true the new MatrixLookup will consist
    7272    /// of the row vectors defined by @a index. This means that the
    7373    /// created MatrixLookup will fullfill:
     
    120120    /// underlying matrix to avoid multiple lookups.
    121121    ///
    122     /// If @a row_vectors is true the new MatrixLookup will be consist
     122    /// If @a row_vectors is true the new MatrixLookup will consist
    123123    /// of the row vectors defined by @a index. This means that the
    124124    /// created MatrixLookup will fullfill:
    125125    /// \f$ MatrixLookup(i,j)=ml(i,index[j])\f$
    126126    ///
    127     /// If @a row_vectors is false the new MatrixLookup will be consist
     127    /// If @a row_vectors is false the new MatrixLookup will consist
    128128    /// of the rolumn vectors defined by @a index. This means that the
    129129    /// created MatrixLookup will fullfill:
     
    156156
    157157    ///
    158     /// Destructor. If MatrixLookup is owner of underlying matrix, the
    159     /// matrix is destroyed.
     158    /// Destructor.
    160159    ///
    161160    virtual ~MatrixLookup();
    162161
    163     ///
    164     /// @todo doc
    165     ///   
     162    /**
     163       the new MatrixLookup will consist of the rolumn vectors
     164       defined by @a index. This means that the returned MatrixLookup
     165       will fullfill: \f$ returned(i,j) = original(index[i],j) \f$
     166
     167       @note If underlying matrix goes out of scope or is deleted, the
     168       returned pointer becomes invalid and the result of further use is
     169       undefined.
     170   
     171    */
    166172    const MatrixLookup* selected(const std::vector<size_t>&) const;
    167173
     
    177183    /// returned pointer becomes invalid and the result of further use is
    178184    /// undefined.
     185    ///
     186    /// @Note Returns a dynamically allocated DataLookup2D, which has
     187    /// to be deleted by the caller to avoid memory leaks.
    179188    ///
    180189    const MatrixLookup* training_data(const std::vector<size_t>& index) const;
     
    192201    /// undefined.
    193202    ///
     203    /**
    194204    const MatrixLookup* training_data(const std::vector<size_t>& features,
    195205                                      const std::vector<size_t>& samples) const;
    196    
     206    */
    197207    ///
    198208    /// The created MatrixLookup corresponds to all rows and the
     
    221231    /// undefined.
    222232    ///
     233    /**
    223234    const MatrixLookup* validation_data(const std::vector<size_t>& features,
    224235                                        const std::vector<size_t>& train,
    225236                                        const std::vector<size_t>& val) const;
     237    */
    226238    ///
    227239    /// @return false
Note: See TracChangeset for help on using the changeset viewer.