annotate carfac/car_state.h @ 640:d08c02c8e26f

More small style revisions to C++ CARFAC, adjusted struct member variable naming, header guards and #include structure.

//
//  car_state.h
//  CARFAC Open Source C++ Library
//
//  Created by Alex Brandmeyer on 5/10/13.
//
// This C++ file is part of an implementation of Lyon's cochlear model:
// "Cascade of Asymmetric Resonators with Fast-Acting Compression"
// to supplement Lyon's upcoming book "Human and Machine Hearing"
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef CARFAC_CAR_STATE_H
#define CARFAC_CAR_STATE_H

#include "carfac_common.h"

struct CARState {
  FloatArray z1_memory;
  FloatArray z2_memory;
  FloatArray za_memory;
  FloatArray zb_memory;
  FloatArray dzb_memory;
  FloatArray zy_memory;
  FloatArray g_memory;
  FloatArray dg_memory;
};

#endif  // CARFAC_CAR_STATE_H