Class: SyMath::Definition::Grad

Inherits:
Operator show all
Defined in:
lib/symath/definition/grad.rb

Instance Attribute Summary

Attributes inherited from Operator

#args, #exp

Attributes inherited from SyMath::Definition

#name

Instance Method Summary collapse

Methods inherited from Operator

#<=>, #==, #arity, #call, #compose_with_simplify, #dump, #evaluate_call, init_builtin, #is_operator?, #latex_format, operators, #replace, #to_s, #validate_args

Methods inherited from SyMath::Definition

#<=>, #==, #arity, define, defined?, definitions, get, #hash, init_builtin, #inspect, #is_constant?, #is_function?, #is_operator?, #reduce_call, #replace, #to_s, undefine, #variables

Methods inherited from Value

#*, #**, #+, #-, #-@, #/, #<, #<=, #<=>, #>, #>=, #^, #add, #base, compose_with_simplify, create, #deep_clone, #div, #dump, #evaluate, #exponent, #factors, #inspect, #inv, #is_divisor_factor?, #is_finite?, #is_nan?, #is_negative?, #is_negative_number?, #is_number?, #is_positive?, #is_prod_exp?, #is_sum_exp?, #is_unit_quaternion?, #is_zero?, #mul, #neg, #power, #reduce, #reduce_modulo_sign, #sign, #sub, #terms, #to_m, #type, #wedge

Methods included from Operation::Exterior

#flat, #hodge, #sharp

Methods included from Operation::Integration

#anti_derivative, #get_linear_constants, initialize, #int_constant, #int_failure, #int_function, #int_inv, #int_pattern, #int_power, #int_product, #int_sum, #integral_bounds

Methods included from Operation::Differential

#_d_wedge, #d, #d_failure, #d_fraction, #d_function, #d_function_def, #d_power, #d_product, initialize

Methods included from Operation

#iterate, #recurse

Methods included from Operation::DistributiveLaw

#combfrac_add_term, #combfrac_sum, #combine_fractions, #expand, #expand_product, #expand_single_pass, #factorize, #factorize_integer_poly, #factorize_simple, #has_fractional_terms?

Methods included from Operation::Normalization

#combine_factors, #compare_factors_and_swap, #normalize, #normalize_matrix, #normalize_power, #normalize_product, #normalize_single_pass, #normalize_sum, #order_product, #product_on_fraction_form, #reduce_constant_factors, #replace_combined_factors, #swap_factors

Methods included from Operation::Match

#build_assoc_op, #match, #match_assoc, #match_replace

Constructor Details

#initialize ⇒ Grad

Returns a new instance of Grad.



6
7
8
9
 
# File 'lib/symath/definition/grad.rb', line 6

def initialize()
  # Grad is defined as (dF)#
  super(:grad, args: [:f], exp: '#(xd(f))')
end

Instance Method Details

#description ⇒ Object 



11
12
13
 
# File 'lib/symath/definition/grad.rb', line 11

def description()
  return 'grad(f) - gradient of scalar field f'
end

#to_latex(args) ⇒ Object 



15
16
17
18
19
20
21
 
# File 'lib/symath/definition/grad.rb', line 15

def to_latex(args)
  if !args
    args = @args
  end

  return "\\nabla #{args[0].to_latex}"
end