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
  • pixel_from_camera_point_with_jacobians()
  • camera_ray_from_pixel_with_jacobians()
  • make_camera_funcs()
  • cam_class_data()
  • class_template_data()
  • camera_data()
  • posed_camera_data()
  • cam_cal_from_points()
  • generate()
• symforce.codegen.codegen module
  • LinearizationMode
    • LinearizationMode.STACKED_JACOBIAN
    • LinearizationMode.FULL_LINEARIZATION
  • GeneratedPaths
    • GeneratedPaths.output_dir
    • GeneratedPaths.lcm_type_dir
    • GeneratedPaths.function_dir
    • GeneratedPaths.python_types_dir
    • GeneratedPaths.cpp_types_dir
    • GeneratedPaths.generated_files
    • GeneratedPaths.__init__()
  • InvalidNamespaceError
  • InvalidNameError
  • CodeGenerationException
  • Codegen
    • Codegen.__init__()
    • Codegen.output_symbols
    • Codegen.function()
    • Codegen.common_data()
    • Codegen.print_code_results
    • Codegen.unused_arguments
    • Codegen.total_ops()
    • Codegen.generate_function()
    • Codegen.default_docstring()
    • Codegen.wrap_docstring_arg_description()
    • Codegen.with_linearization()
    • Codegen.with_jacobians()
• symforce.codegen.codegen_config module
  • ZeroEpsilonBehavior
    • ZeroEpsilonBehavior.FAIL
    • ZeroEpsilonBehavior.WARN
    • ZeroEpsilonBehavior.ALLOW
  • RenderTemplateConfig
    • RenderTemplateConfig.autoformat
    • RenderTemplateConfig.custom_preamble
    • RenderTemplateConfig.__init__()
  • CodegenConfig
    • CodegenConfig.doc_comment_line_prefix
    • CodegenConfig.line_length
    • CodegenConfig.use_eigen_types
    • CodegenConfig.render_template_config
    • CodegenConfig.cse_optimizations
    • CodegenConfig.zero_epsilon_behavior
    • CodegenConfig.backend_name()
    • CodegenConfig.template_dir()
    • CodegenConfig.templates_to_render()
    • CodegenConfig.printer()
    • CodegenConfig.format_data_accessor()
    • CodegenConfig.format_matrix_accessor()
    • CodegenConfig.format_eigen_lcm_accessor()
    • CodegenConfig.update_template_data()
    • CodegenConfig.__init__()
• symforce.codegen.codegen_util module
  • DenseAndSparseOutputTerms
    • DenseAndSparseOutputTerms.dense
    • DenseAndSparseOutputTerms.sparse
  • OutputWithTerms
    • OutputWithTerms.name
    • OutputWithTerms.type
    • OutputWithTerms.terms
  • PrintCodeResult
    • PrintCodeResult.intermediate_terms
    • PrintCodeResult.dense_terms
    • PrintCodeResult.sparse_terms
    • PrintCodeResult.total_ops
  • CSCFormat
    • CSCFormat.kRows
    • CSCFormat.kCols
    • CSCFormat.kNumNonZero
    • CSCFormat.kColPtrs
    • CSCFormat.kRowIndices
    • CSCFormat.nonzero_elements
    • CSCFormat.from_matrix()
    • CSCFormat.to_matrix()
    • CSCFormat.__init__()
  • 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
    • LcmBindingsDirs.python_types_dir
    • LcmBindingsDirs.cpp_types_dir
    • LcmBindingsDirs.__init__()
  • generate_lcm_types()
  • flat_symbols_from_values()
• symforce.codegen.format_util module
  • format_cpp()
  • format_py()
  • format_pyi()
  • 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
    • SimilarityIndex.config
    • SimilarityIndex.inputs
    • SimilarityIndex.outputs
    • SimilarityIndex.return_key
    • SimilarityIndex.sorted_sparse_matrices
    • SimilarityIndex.sparse_matrices
    • SimilarityIndex.from_codegen()
    • SimilarityIndex.__hash__()
    • SimilarityIndex.__init__()
• symforce.codegen.slam_factors_codegen module
  • inverse_range_landmark_prior_residual()
  • reprojection_delta()
  • inverse_range_landmark_reprojection_error_residual()
  • ray_reprojection_delta()
  • inverse_range_landmark_ray_reprojection_error_residual()
  • generate()
• symforce.codegen.sym_util_package_codegen module
  • generate()
• symforce.codegen.template_util module
  • FileType
    • FileType.CPP
    • FileType.PYTHON
    • FileType.PYTHON_INTERFACE
    • FileType.CUDA
    • FileType.LCM
    • FileType.MAKEFILE
    • FileType.TYPESCRIPT
    • FileType.from_extension()
    • FileType.from_template_path()
    • FileType.comment_prefix()
    • FileType.autoformat()
  • RelEnvironment
    • RelEnvironment.join_path()
  • add_preamble()
  • jinja_env()
  • render_template()
  • TemplateList
    • TemplateList.TemplateListEntry
      • TemplateList.TemplateListEntry.template_path
      • TemplateList.TemplateListEntry.data
      • TemplateList.TemplateListEntry.config
      • TemplateList.TemplateListEntry.template_dir
      • TemplateList.TemplateListEntry.output_path
      • TemplateList.TemplateListEntry.__init__()
    • TemplateList.__init__()
    • TemplateList.add()
    • TemplateList.render()
• symforce.codegen.types_package_codegen module
  • TypesCodegenData
    • TypesCodegenData.package_name
    • TypesCodegenData.values_indices
    • TypesCodegenData.shared_types
    • TypesCodegenData.scalar_type
    • TypesCodegenData.output_dir
    • TypesCodegenData.lcm_type_dir
    • TypesCodegenData.lcm_bindings_output_dir
    • TypesCodegenData.lcm_files
    • TypesCodegenData.types_dict
    • TypesCodegenData.typenames_dict
    • TypesCodegenData.namespaces_dict
    • TypesCodegenData.lcm_bindings_dirs
    • TypesCodegenData.__init__()
  • generate_types()
  • build_types_dict()
  • typename_from_key()
  • get_subvalues_from_list_index()
• symforce.codegen.values_codegen module
  • generate_values_keys()