Add matfaust.factparams.MHTPParams.

gen_doc/CMakeLists.txt

@@ -31,7 +31,7 @@ if(BUILD_DOCUMENTATION)
 			string(CONCAT DOXYGEN_FILE_PATTERNS "*.cpp *.hpp *.h *.cu *.hu")
 		endif()
 		if(BUILD_WRAPPER_MATLAB)
-			string(CONCAT DOXYGEN_FILE_PATTERNS ${DOXYGEN_FILE_PATTERNS} " Faust.m FaustMulMode.m StoppingCriterion.m ConstraintGeneric.m ConstraintMat.m ConstraintReal.m ConstraintInt.m ConstraintName.m ParamsFact.m ParamsHierarchical.m ParamsPalm4MSA.m FaustFactory.m hadamard.m quickstart.m fft.m bsl.m runtimecmp.m runall.m version.m faust_fact.m ParamsHierarchicalSquareMat.m ParamsHierarchicalRectMat.m license.m omp.m wht.m dft.m eye.m rand.m  eigtj.m hierarchical.m fact.m palm4msa.m fgft_givens.m fgft_palm.m svdtj.m splin.m spcol.m proj_gen.m sp.m const.m supp.m hankel.m toeplitz.m circ.m normcol.m normlin.m splincol.m blockdiag.m skperm.m enable_gpu_mod.m isFaust.m poly.m basis.m next.m  expm_multiply.m FaustPoly.m ") # warning: the space on the end matters
+			string(CONCAT DOXYGEN_FILE_PATTERNS ${DOXYGEN_FILE_PATTERNS} " Faust.m FaustMulMode.m StoppingCriterion.m ConstraintGeneric.m ConstraintMat.m ConstraintReal.m ConstraintInt.m ConstraintName.m ParamsFact.m ParamsHierarchical.m ParamsPalm4MSA.m FaustFactory.m hadamard.m quickstart.m fft.m bsl.m runtimecmp.m runall.m version.m faust_fact.m ParamsHierarchicalSquareMat.m ParamsHierarchicalRectMat.m license.m omp.m wht.m dft.m eye.m rand.m  eigtj.m hierarchical.m fact.m palm4msa.m fgft_givens.m fgft_palm.m svdtj.m splin.m spcol.m proj_gen.m sp.m const.m supp.m hankel.m toeplitz.m circ.m normcol.m normlin.m splincol.m blockdiag.m skperm.m enable_gpu_mod.m isFaust.m poly.m basis.m next.m  expm_multiply.m FaustPoly.m MHTPParams.m ") # warning: the space on the end matters
 		endif()
 		if(BUILD_WRAPPER_PYTHON)
 			string(CONCAT DOXYGEN_FILE_PATTERNS ${DOXYGEN_FILE_PATTERNS} "__init__.py factparams.py demo.py tools.py fact.py proj.py poly.py")

gen_doc/Doxyfile.in

@@ -520,7 +520,7 @@ EXCLUDE_SYMLINKS       = NO
 
 EXCLUDE_PATTERNS       = *faust_MatDense_gpu.h *faust_MatSparse_gpu.h expfiltered*
 
-EXCLUDE_SYMBOLS = mtimes_trans subsasgn get_factor_nonopt reshape ABC ParamsPalm4MSAFGFT UpdateCholesky UpdateCholeskyFull UpdateCholeskySparse greed_omp_chol hierarchical_constends palm4msa_constends is_mat_consistent init_facts stop_crit ParamsPalm4MSAFGFT data_num_cols data_num_rows is_fact_side_left stop_crits constant_step_size constraints DISABLED_OPT EXTERNAL_OPT grad_calc_opt_mode init_lambda INTERNAL_OPT is_update_way_R2L is_verbose num_facts step_size IDX_IS_FACT_SIDE_LEFT OPT_ARG_NAMES2 OPT_ARG_NAMES DEFAULT_OPT IDX_USE_CSR IDX_NORM2_MAX_ITER IDX_NORM2_THRESHOLD IDX_GRAD_CALC_OPT_MODE IDX_VERBOSITY IDX_CONSTANT_STEP_SIZE IDX_STEP_SIZE IDX_INIT_LAMBDA IDX_IS_UPDATE_WAY_R2L set_FM_mul_mode set_Fv_mul_mode implements HANDLED_FUNCTIONS __array_ufunc__ __array__ __array_function__ asarray check_dev _eyes_like _poly_arr_py _zeros_like Chebyshev to_mex_struct get_default_init_facts IDX_INIT_FACTS palm4msa_period updating_lambda
+EXCLUDE_SYMBOLS = mtimes_trans subsasgn get_factor_nonopt reshape ABC ParamsPalm4MSAFGFT UpdateCholesky UpdateCholeskyFull UpdateCholeskySparse greed_omp_chol hierarchical_constends palm4msa_constends is_mat_consistent init_facts stop_crit ParamsPalm4MSAFGFT data_num_cols data_num_rows is_fact_side_left stop_crits constraints DISABLED_OPT EXTERNAL_OPT grad_calc_opt_mode init_lambda INTERNAL_OPT is_update_way_R2L is_verbose num_facts IDX_IS_FACT_SIDE_LEFT OPT_ARG_NAMES2 OPT_ARG_NAMES DEFAULT_OPT IDX_USE_CSR IDX_NORM2_MAX_ITER IDX_NORM2_THRESHOLD IDX_GRAD_CALC_OPT_MODE IDX_VERBOSITY IDX_CONSTANT_STEP_SIZE IDX_STEP_SIZE IDX_INIT_LAMBDA IDX_IS_UPDATE_WAY_R2L set_FM_mul_mode set_Fv_mul_mode implements HANDLED_FUNCTIONS __array_ufunc__ __array__ __array_function__ asarray check_dev _eyes_like _poly_arr_py _zeros_like Chebyshev to_mex_struct get_default_init_facts IDX_INIT_FACTS 
 # ConstraintGeneric ConstraintMat ConstraintReal ConstraintName ConstraintInt
 
 # The EXAMPLE_PATH tag can be used to specify one or more files or 

wrapper/python/pyfaust/factparams.py

@@ -703,11 +703,12 @@ class ConstraintList(object):
         """
         return self.clist.__getitem__(ind)
 
+# experimental block start
 class MHTPParams:
     """
     This class defines the set of parameters to run the MHTP-PAL4MSA algorithm.
 
-    <b/> See also pyfaust.fact.palm4msa_mhtp
+    <b/> See also pyfaust.fact.palm4msa_mhtp, pyfaust.fact.hierarchical_mhtp
     """
     def __init__(self, num_its=50,
                  constant_step_size=False, step_size=1e-3,
@@ -716,7 +717,7 @@ class MHTPParams:
         """
         Constructor of the MHTPParams class.
 
-        <b/> See also pyfaust.fact.palm4msa_mhtp
+        <b/> See also pyfaust.fact.palm4msa_mhtp, pyfaust.fact.hierarchical_mhtp
 
         Args:
             num_its: (int, optional) the number of iterations to run the MHTP algorithm.
@@ -751,7 +752,7 @@ class MHTPParams:
         The MHTPParams instance str representation.
         """
         return str(MHTP_stop_crit)
-
+# experimental block end
 
 class ParamsFact(ABC):
     """