src.libs/CjNP_eigenvalDump.hh

/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 4; tab-width: 4 -*- */
/*
 * mitie
 * Copyright (C) Jason Spencer 2009 <mitie@jasonspencer.org>
 * 
 * mitie is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * mitie is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along
 * with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef _CJNP_EIGENVALDUMP_H_
#define _CJNP_EIGENVALDUMP_H_ 1

#include <string>
#include <stdexcept>
#include "CjNP_LoggableBase.hh"

namespace jmitie {
namespace corelib {
class CjNP_eigenvalDump : public CjNP_LoggableBase {

public:
std::string getName() const { return getName_static(); }
static std::string getName_static() { return "eigenvalDump"; }
std::string getProperty(const std::string & prop) const { return getProperty_static(prop); }
static std::string getProperty_static(const std::string & opt) {
        if(opt=="desc") return "Prints the sorted eigenvalues of the adjacency matrix of the topology";
        if(opt=="usage") return getProperty_static("desc") + "\nAvailable common logging options:\n" + CjNP_LoggableBase::getProperty_static(opt) + \
        "Additionally the following options:\n[count=integer],[prec=integer],(asc|desc),(adj|comb_lap|sign_lap|norm_lap)\nWhere:\n" + \
        "[count=integer]\tOutputs only first integer number of eigenvalues\n" + \
        "[prec=integer]\tSets the number of decimal places to print when outputting the eigenvalues" + \
        "asc|desc\tSorts the eigenvalues in ascending or descending order prior to output.\n" + \
        "adj\ttakes the eigenvalue of the adjacency matrix where adj(i,j) is 1.0 if i and j are connected, 0.0 otherwise.\n" + \
        "comb_lap\ttakes the eigenvalue of the combinatorial laplacian adjacency matrix where adj(i,j) is -1.0 if i and j are connected, adj(i,i) is the degree of node i, and 0.0 otherwise.\n" + \
        "sign_lap\ttakes the eigenvalue of the sign-less combinatorial laplacian adjacency matrix where adj(i,j) is 1.0 if i and j are connected, adj(i,i) is the degree of node i, and 0.0 otherwise.\n" + \
        "norm_lap\ttakes the eigenvalue of the normalised laplacian adjacency matrix where adj(i,j) is -( (deg(i)*deg(j))^-0.5 ) if i and j are connected, adj(i,i) is 1.0, and 0.0 otherwise.\n";
        
        throw std::invalid_argument("CjNP_adjLDump::getProperty_static(" + opt + "): Unknown property requested.");
}

CjNP_eigenvalDump(const std::string & args, const ctor_va_t & var_arg );
virtual void performAction( const action_va_t & opts );

~CjNP_eigenvalDump();

protected:
enum mat_preproc_t { NONE, ADJ, COMBLAP, NOSIGNLAP, NORMLAP };
mat_preproc_t m_mat_type;
unsigned int m_count;   // the number of values to print - 0 for all
unsigned int m_prec;    // the number of decimal places to print
bool m_desc_asc;        // if false then values will be printed in descending order

};
} // namespace corelib
} // namespace jmitie

#endif // _CJNP_EIGENVALDUMP_H_