Commenting unused parameters for better readibility

Change-Id: Idc285fa68ba787636a69a3ea3350e0282b9f8569
This commit is contained in:
Alexander Ivanov
2023-01-09 11:23:12 +00:00
committed by Sameer Agarwal
parent 772d927e19
commit f1113c08ab
28 changed files with 53 additions and 45 deletions
+1
View File
@@ -186,6 +186,7 @@ def ceres_library(name,
]),
copts = [
"-I" + internal,
"-Wunused-parameter",
"-Wno-sign-compare",
] + schur_eliminator_copts,
+1 -1
View File
@@ -46,7 +46,7 @@ StateUpdatingCallback::StateUpdatingCallback(Program* program,
StateUpdatingCallback::~StateUpdatingCallback() = default;
CallbackReturnType StateUpdatingCallback::operator()(
const IterationSummary& summary) {
const IterationSummary& /*summary*/) {
program_->StateVectorToParameterBlocks(parameters_);
program_->CopyParameterBlockStateToUserState();
return SOLVER_CONTINUE;
@@ -62,7 +62,7 @@ bool CoordinateDescentMinimizer::Init(
const Program& program,
const ProblemImpl::ParameterMap& parameter_map,
const ParameterBlockOrdering& ordering,
std::string* error) {
std::string* /*error*/) {
parameter_blocks_.clear();
independent_set_offsets_.clear();
independent_set_offsets_.push_back(0);
@@ -118,7 +118,7 @@ bool CoordinateDescentMinimizer::Init(
void CoordinateDescentMinimizer::Minimize(const Minimizer::Options& options,
double* parameters,
Solver::Summary* summary) {
Solver::Summary* /*summary*/) {
// Set the state and mark all parameter blocks constant.
for (auto* parameter_block : parameter_blocks_) {
parameter_block->SetState(parameters + parameter_block->state_offset());
-5
View File
@@ -468,17 +468,12 @@ bool CovarianceImpl::ComputeCovarianceSparsity(
// Iterate over the covariance blocks contained in this row block
// and count the number of columns in this row block.
int num_col_blocks = 0;
// TODO(sameeragarwal): num_columns is being computed but not
// being used.
int num_columns = 0;
for (int j = i; j < covariance_blocks.size(); ++j, ++num_col_blocks) {
const std::pair<const double*, const double*>& block_pair =
covariance_blocks[j];
if (block_pair.first != row_block) {
break;
}
num_columns += problem->ParameterBlockTangentSize(block_pair.second);
}
// Fill out all the compressed rows for this parameter block.
+1 -1
View File
@@ -632,7 +632,7 @@ void DoglegStrategy::StepAccepted(double step_quality) {
reuse_ = false;
}
void DoglegStrategy::StepRejected(double step_quality) {
void DoglegStrategy::StepRejected(double /*step_quality*/) {
radius_ *= 0.5;
reuse_ = true;
}
@@ -175,6 +175,8 @@ LinearSolver::Summary
DynamicSparseNormalCholeskySolver::SolveImplUsingSuiteSparse(
CompressedRowSparseMatrix* A, double* rhs_and_solution) {
#ifdef CERES_NO_SUITESPARSE
(void) A;
(void) rhs_and_solution;
LinearSolver::Summary summary;
summary.num_iterations = 0;
@@ -131,7 +131,7 @@ GradientCheckingIterationCallback::GradientCheckingIterationCallback()
: gradient_error_detected_(false) {}
CallbackReturnType GradientCheckingIterationCallback::operator()(
const IterationSummary& summary) {
const IterationSummary& /*summary*/) {
if (gradient_error_detected_) {
LOG(ERROR) << "Gradient error detected. Terminating solver.";
return SOLVER_ABORT;
+2 -2
View File
@@ -52,10 +52,10 @@ class CERES_NO_EXPORT GradientProblemEvaluator final : public Evaluator {
std::unique_ptr<SparseMatrix> CreateJacobian() const final { return nullptr; }
bool Evaluate(const EvaluateOptions& evaluate_options,
bool Evaluate(const EvaluateOptions& /*evaluate_options*/,
const double* state,
double* cost,
double* residuals,
double* /*residuals*/,
double* gradient,
SparseMatrix* jacobian) final {
CHECK(jacobian == nullptr);
@@ -163,7 +163,7 @@ void LevenbergMarquardtStrategy::StepAccepted(double step_quality) {
reuse_diagonal_ = false;
}
void LevenbergMarquardtStrategy::StepRejected(double step_quality) {
void LevenbergMarquardtStrategy::StepRejected(double /*step_quality*/) {
radius_ = radius_ / decrease_factor_;
decrease_factor_ *= 2.0;
reuse_diagonal_ = true;
+1 -1
View File
@@ -42,7 +42,7 @@ namespace ceres::internal {
class CERES_NO_EXPORT SteepestDescent final : public LineSearchDirection {
public:
bool NextDirection(const LineSearchMinimizer::State& previous,
bool NextDirection(const LineSearchMinimizer::State& /*previous*/,
const LineSearchMinimizer::State& current,
Vector* search_direction) override {
*search_direction = -current.gradient;
+1 -1
View File
@@ -46,7 +46,7 @@ namespace ceres::internal {
class CERES_NO_EXPORT LineSearchMinimizer final : public Minimizer {
public:
struct State {
State(int num_parameters, int num_effective_parameters)
State(int /*num_parameters*/, int num_effective_parameters)
: cost(0.0),
gradient(num_effective_parameters),
gradient_squared_norm(0.0),
@@ -930,7 +930,7 @@ bool DumpLinearLeastSquaresProblemToConsole(const SparseMatrix* A,
const double* D,
const double* b,
const double* x,
int num_eliminate_blocks) {
int /*num_eliminate_blocks*/) {
CHECK(A != nullptr);
Matrix AA;
A->ToDenseMatrix(&AA);
@@ -968,7 +968,7 @@ bool DumpLinearLeastSquaresProblemToTextFile(const std::string& filename_base,
const double* D,
const double* b,
const double* x,
int num_eliminate_blocks) {
int /*num_eliminate_blocks*/) {
CHECK(A != nullptr);
LOG(INFO) << "writing to: " << filename_base << "*";
+3 -3
View File
@@ -196,7 +196,7 @@ bool SubsetManifold::Plus(const double* x,
return true;
}
bool SubsetManifold::PlusJacobian(const double* x,
bool SubsetManifold::PlusJacobian(const double* /*x*/,
double* plus_jacobian) const {
if (tangent_size_ == 0) {
return true;
@@ -213,7 +213,7 @@ bool SubsetManifold::PlusJacobian(const double* x,
return true;
}
bool SubsetManifold::RightMultiplyByPlusJacobian(const double* x,
bool SubsetManifold::RightMultiplyByPlusJacobian(const double* /*x*/,
const int num_rows,
const double* ambient_matrix,
double* tangent_matrix) const {
@@ -249,7 +249,7 @@ bool SubsetManifold::Minus(const double* y,
return true;
}
bool SubsetManifold::MinusJacobian(const double* x,
bool SubsetManifold::MinusJacobian(const double* /*x*/,
double* minus_jacobian) const {
const int ambient_size = AmbientSize();
MatrixRef m(minus_jacobian, tangent_size_, ambient_size);
-1
View File
@@ -152,7 +152,6 @@ bool MaxPartitionCostIsFeasible(int start,
int partition_start = start;
int cost_offset = cumulative_cost_offset;
const CumulativeCostData* const range_end = cumulative_cost_data + end;
while (partition_start < end) {
// Already have max_num_partitions
if (partition->size() > max_num_partitions) {
+1 -2
View File
@@ -63,8 +63,7 @@ void BlockUntilFinished::Block() {
ThreadPoolState::ThreadPoolState(int start,
int end,
int num_work_blocks,
int num_workers)
int num_work_blocks)
: start(start),
end(end),
num_work_blocks(num_work_blocks),
+2 -2
View File
@@ -87,7 +87,7 @@ struct ThreadPoolState {
// Note that this splitting is optimal in the sense of maximal difference
// between block sizes, since splitting into equal blocks is possible
// if and only if number of indices is divisible by number of blocks.
ThreadPoolState(int start, int end, int num_work_blocks, int num_workers);
ThreadPoolState(int start, int end, int num_work_blocks);
// The start and end index of the for loop.
const int start;
@@ -160,7 +160,7 @@ void ParallelInvoke(ContextImpl* context,
// the work before the tasks have been popped off the queue. So the
// shared state needs to exist for the duration of all the tasks.
std::shared_ptr<ThreadPoolState> shared_state(
new ThreadPoolState(start, end, num_work_blocks, num_threads));
new ThreadPoolState(start, end, num_work_blocks));
// A function which tries to perform several chunks of work.
auto task = [shared_state, num_threads, &function]() {
@@ -43,8 +43,8 @@ PowerSeriesExpansionPreconditioner::PowerSeriesExpansionPreconditioner(
PowerSeriesExpansionPreconditioner::~PowerSeriesExpansionPreconditioner() =
default;
bool PowerSeriesExpansionPreconditioner::Update(const LinearOperator& A,
const double* D) {
bool PowerSeriesExpansionPreconditioner::Update(const LinearOperator& /*A*/,
const double* /*D*/) {
return true;
}
+2 -2
View File
@@ -55,8 +55,8 @@ SparseMatrixPreconditionerWrapper::SparseMatrixPreconditionerWrapper(
SparseMatrixPreconditionerWrapper::~SparseMatrixPreconditionerWrapper() =
default;
bool SparseMatrixPreconditionerWrapper::UpdateImpl(const SparseMatrix& A,
const double* D) {
bool SparseMatrixPreconditionerWrapper::UpdateImpl(const SparseMatrix& /*A*/,
const double* /*D*/) {
return true;
}
+1 -1
View File
@@ -147,7 +147,7 @@ class CERES_NO_EXPORT IdentityPreconditioner : public Preconditioner {
public:
IdentityPreconditioner(int num_rows) : num_rows_(num_rows) {}
bool Update(const LinearOperator& A, const double* D) final { return true; }
bool Update(const LinearOperator& /*A*/, const double* /*D*/) final { return true; }
void RightMultiplyAndAccumulate(const double* x, double* y) const final {
VectorRef(y, num_rows_) += ConstVectorRef(x, num_rows_);
+1 -1
View File
@@ -359,7 +359,7 @@ void ProblemImpl::AddParameterBlock(double* values, int size) {
InternalAddParameterBlock(values, size);
}
void ProblemImpl::InternalSetManifold(double* values,
void ProblemImpl::InternalSetManifold(double* /*values*/,
ParameterBlock* parameter_block,
Manifold* manifold) {
if (manifold != nullptr && options_.manifold_ownership == TAKE_OWNERSHIP) {
+1 -1
View File
@@ -105,7 +105,7 @@ namespace ceres {
namespace internal {
struct NullJacobianFinalizer {
void operator()(SparseMatrix* jacobian, int num_parameters) {}
void operator()(SparseMatrix* /*jacobian*/, int /*num_parameters*/) {}
};
template <typename EvaluatePreparer,
+15 -4
View File
@@ -113,6 +113,12 @@ void OrderingForSparseNormalCholeskyUsingSuiteSparse(
const ParameterBlockOrdering& parameter_block_ordering,
int* ordering) {
#ifdef CERES_NO_SUITESPARSE
// "Void"ing values to avoid compiler warnings about unused parameters
(void) linear_solver_ordering_type;
(void) tsm_block_jacobian_transpose;
(void) parameter_blocks;
(void) parameter_block_ordering;
(void) ordering;
LOG(FATAL) << "Congratulations, you found a Ceres bug! "
<< "Please report this error to the developers.";
#else
@@ -243,7 +249,7 @@ bool ApplyOrdering(const ProblemImpl::ParameterMap& parameter_map,
bool LexicographicallyOrderResidualBlocks(
const int size_of_first_elimination_group,
Program* program,
std::string* error) {
std::string* /*error*/) {
CHECK_GE(size_of_first_elimination_group, 1)
<< "Congratulations, you found a Ceres bug! Please report this error "
<< "to the developers.";
@@ -324,8 +330,13 @@ bool LexicographicallyOrderResidualBlocks(
// Pre-order the columns corresponding to the Schur complement if
// possible.
static void ReorderSchurComplementColumnsUsingSuiteSparse(
const ParameterBlockOrdering& parameter_block_ordering, Program* program) {
#ifndef CERES_NO_SUITESPARSE
const ParameterBlockOrdering& parameter_block_ordering,
Program* program) {
#ifdef CERES_NO_SUITESPARSE
// "Void"ing values to avoid compiler warnings about unused parameters
(void) parameter_block_ordering;
(void) program;
#else
SuiteSparse ss;
std::vector<int> constraints;
std::vector<ParameterBlock*>& parameter_blocks =
@@ -365,7 +376,7 @@ static void ReorderSchurComplementColumnsUsingSuiteSparse(
static void ReorderSchurComplementColumnsUsingEigen(
LinearSolverOrderingType ordering_type,
const int size_of_first_elimination_group,
const ProblemImpl::ParameterMap& parameter_map,
const ProblemImpl::ParameterMap& /*parameter_map*/,
Program* program) {
#if defined(CERES_USE_EIGEN_SPARSE)
std::unique_ptr<TripletSparseMatrix> tsm_block_jacobian_transpose(
+1 -2
View File
@@ -113,8 +113,7 @@ bool ResidualBlock::Evaluate(const bool apply_loss_function,
return false;
}
if (!IsEvaluationValid(
*this, parameters.data(), cost, residuals, eval_jacobians)) {
if (!IsEvaluationValid(*this, parameters.data(), residuals, eval_jacobians)) {
// clang-format off
std::string message =
"\n\n"
+4 -2
View File
@@ -114,9 +114,11 @@ std::string EvaluationToString(const ResidualBlock& block,
return result;
}
// TODO(sameeragarwal) Check cost value validness here
// Cost value is a part of evaluation but not checked here since according to residual_block.cc
// cost is not valid at the time this method is called
bool IsEvaluationValid(const ResidualBlock& block,
double const* const* parameters,
double* cost,
double const* const* /*parameters*/,
double* residuals,
double** jacobians) {
const int num_parameter_blocks = block.NumParameterBlocks();
-1
View File
@@ -63,7 +63,6 @@ void InvalidateEvaluation(const ResidualBlock& block,
CERES_NO_EXPORT
bool IsEvaluationValid(const ResidualBlock& block,
double const* const* parameters,
double* cost,
double* residuals,
double** jacobians);
+1 -1
View File
@@ -179,7 +179,7 @@ void DenseSchurComplementSolver::InitStorage(
// BlockRandomAccessDenseMatrix. The linear system is solved using
// Eigen's Cholesky factorization.
LinearSolver::Summary DenseSchurComplementSolver::SolveReducedLinearSystem(
const LinearSolver::PerSolveOptions& per_solve_options, double* solution) {
const LinearSolver::PerSolveOptions& /*per_solve_options*/, double* solution) {
LinearSolver::Summary summary;
summary.num_iterations = 0;
summary.termination_type = LinearSolverTerminationType::SUCCESS;
+3 -2
View File
@@ -382,8 +382,9 @@ template <int kRowBlockSize = Eigen::Dynamic,
class CERES_NO_EXPORT SchurEliminatorForOneFBlock final
: public SchurEliminatorBase {
public:
// TODO(sameeragarwal) Find out why "assume_full_rank_ete" is not used here
void Init(int num_eliminate_blocks,
bool assume_full_rank_ete,
bool /*assume_full_rank_ete*/,
const CompressedRowBlockStructure* bs) override {
CHECK_GT(num_eliminate_blocks, 0)
<< "SchurComplementSolver cannot be initialized with "
@@ -569,7 +570,7 @@ class CERES_NO_EXPORT SchurEliminatorForOneFBlock final
// y_i = e_t_e_inverse * sum_i e_i^T * (b_i - f_i * z);
void BackSubstitute(const BlockSparseMatrixData& A,
const double* b,
const double* D,
const double* /*D*/,
const double* z_ptr,
double* y) override {
typename EigenTypes<kFBlockSize>::ConstVectorRef z(z_ptr, kFBlockSize);
+1 -1
View File
@@ -90,7 +90,7 @@ class CERES_NO_EXPORT SparseMatrix : public LinearOperator {
// A = 0. A->num_nonzeros() == 0 is true after this call. The
// sparsity pattern is preserved.
virtual void SetZero() = 0;
virtual void SetZero(ContextImpl* contex, int num_threads) { SetZero(); }
virtual void SetZero(ContextImpl* /*context*/, int /*num_threads*/) { SetZero(); }
// Resize and populate dense_matrix with a dense version of the
// sparse matrix.