symforce.codegen package

Package for executable code generation from symbolic expressions.

Subpackages

• symforce.codegen.backends package
  • Subpackages
    • symforce.codegen.backends.cpp package
      • Submodules
    • symforce.codegen.backends.cuda package
      • Submodules
    • symforce.codegen.backends.python package
      • Submodules
    • symforce.codegen.backends.pytorch package
      • Submodules

Submodules

• symforce.codegen.cam_package_codegen module
• symforce.codegen.codegen module
  • LinearizationMode
    • STACKED_JACOBIAN
    • FULL_LINEARIZATION
  • GeneratedPaths
    • output_dir
    • lcm_type_dir
    • function_dir
    • python_types_dir
    • cpp_types_dir
    • generated_files
  • InvalidNamespaceError
  • InvalidNameError
  • CodeGenerationException
  • Codegen
    • output_symbols
    • function()
    • common_data()
    • print_code_results
    • unused_arguments
    • total_ops()
    • generate_function()
    • default_docstring()
    • wrap_docstring_arg_description()
    • with_linearization()
    • with_jacobians()
    • lambdify()
• symforce.codegen.codegen_config module
  • ZeroEpsilonBehavior
    • FAIL
    • WARN
    • ALLOW
  • RenderTemplateConfig
    • autoformat
    • custom_preamble
  • CodegenConfig
    • doc_comment_line_prefix
    • line_length
    • use_eigen_types
    • render_template_config
    • cse_optimizations
    • zero_epsilon_behavior
    • normalize_results
    • backend_name()
    • template_dir()
    • templates_to_render()
    • printer()
    • format_data_accessor()
    • format_matrix_accessor()
    • format_eigen_lcm_accessor()
    • update_template_data()
• symforce.codegen.codegen_util module
  • DenseAndSparseOutputTerms
    • dense
    • sparse
  • OutputWithTerms
    • name
    • type
    • terms
  • PrintCodeResult
    • intermediate_terms
    • dense_terms
    • sparse_terms
    • total_ops
  • CSCFormat
    • kRows
    • kCols
    • kNumNonZero
    • kColPtrs
    • kRowIndices
    • nonzero_elements
    • from_matrix()
    • to_matrix()
  • print_code()
  • perform_cse()
  • format_symbols()
  • get_formatted_list()
  • get_formatted_sparse_list()
  • load_generated_package()
  • load_generated_function()
  • load_generated_lcmtype()
  • get_base_instance()
  • LcmBindingsDirs
    • python_types_dir
    • cpp_types_dir
  • generate_lcm_types()
  • flat_symbols_from_values()
• symforce.codegen.format_util module
  • format_cpp()
  • format_py()
  • format_py_dir()
• symforce.codegen.geo_factors_codegen module
  • get_between_factor_docstring()
  • get_prior_docstring()
  • between_factor()
  • prior_factor()
  • generate_between_factors()
  • generate_pose3_extra_factors()
  • generate()
• symforce.codegen.geo_package_codegen module
  • geo_class_common_data()
  • generate()
• symforce.codegen.lcm_types_codegen module
  • lcm_symforce_types_data()
• symforce.codegen.ops_codegen_util module
  • make_group_ops_funcs()
  • make_lie_group_ops_funcs()
• symforce.codegen.similarity_index module
  • SimilarityIndex
    • config
    • inputs
    • outputs
    • return_key
    • sorted_sparse_matrices
    • sparse_matrices
    • from_codegen()
    • __hash__()
• symforce.codegen.slam_factors_codegen module
  • inverse_range_landmark_prior_residual()
  • reprojection_delta()
  • inverse_range_landmark_reprojection_error_residual()
  • inverse_range_landmark_gnc_residual()
  • ray_reprojection_delta()
  • inverse_range_landmark_ray_reprojection_error_residual()
  • inverse_range_landmark_ray_gnc_residual()
  • generate()
• symforce.codegen.sym_util_package_codegen module
  • generate()
• symforce.codegen.template_util module
  • FileType
    • CPP
    • PYTHON
    • PYTHON_INTERFACE
    • CUDA
    • LCM
    • MAKEFILE
    • TYPESCRIPT
    • TOML
    • from_extension()
    • from_template_path()
    • comment_prefix()
    • autoformat()
  • RelEnvironment
    • join_path()
  • add_preamble()
  • jinja_env()
  • render_template()
  • TemplateList
    • TemplateListEntry
      • template_path
      • data
      • config
      • template_dir
      • output_path
    • add()
    • render()
• symforce.codegen.types_package_codegen module
  • TypesCodegenData
    • package_name
    • values_indices
    • shared_types
    • scalar_type
    • output_dir
    • lcm_type_dir
    • lcm_bindings_output_dir
    • lcm_files
    • types_dict
    • typenames_dict
    • namespaces_dict
    • lcm_bindings_dirs
  • generate_types()
  • build_types_dict()
  • typename_from_key()
  • get_subvalues_from_list_index()
• symforce.codegen.values_codegen module
  • generate_values_keys()